nxssetreader.h

//  Copyright (C) 1999-2003 Paul O. Lewis
//
//  This file is part of NCL (Nexus Class Library) version 2.0.
//
//  NCL is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation; either version 2 of the License, or
//  (at your option) any later version.
//
//  NCL is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with NCL; if not, write to the Free Software Foundation, Inc.,
//  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//

#ifndef NCL_NXSSETREADER_H
#define NCL_NXSSETREADER_H
#include <sstream>
#include "ncl/nxstoken.h"
#include "ncl/nxsblock.h"
class NxsSetReader
    {
        static unsigned InterpretTokenAsIndices(NxsToken &t,
                                 const NxsLabelToIndicesMapper &,
                                 const char * setType,
                                 const char * cmd,
                                 NxsUnsignedSet * destination);
        static void AddRangeToSet(unsigned first, unsigned last, unsigned stride, NxsUnsignedSet * destination, const NxsUnsignedSet * taboo, NxsToken &t);
    public:
        static void ReadSetDefinition(NxsToken &t,
                                 const NxsLabelToIndicesMapper &,
                                 const char * setType,
                                 const char * cmd,
                                 NxsUnsignedSet * destination,
                                 const NxsUnsignedSet * taboo = NULL);
        static void WriteSetAsNexusValue(const NxsUnsignedSet   &, std::ostream & out);
        static std::string  GetSetAsNexusString(const NxsUnsignedSet &s)
            {
            std::stringstream os;
            NxsSetReader::WriteSetAsNexusValue(s, os);
            //os << ' ';
            return os.str();
            }
        static std::vector<unsigned> GetSetAsVector(const NxsUnsignedSet &s);
        enum NxsSetReaderEnum   /* For use with the variable `settype' */
            {
            generic = 1,        /* means expect a generic set (say, characters weights) */
            charset,            /* means expect a character set */
            taxset              /* means expect a taxon set */
            };

                        NxsSetReader(NxsToken &t, unsigned maxValue, NxsUnsignedSet &iset, NxsBlock &nxsblk, unsigned type);

        bool            Run();
        void            WriteAsNexusValue(std::ostream & out) const
            {
            WriteSetAsNexusValue(nxsset, out);
            }
    protected:

        bool            AddRange(unsigned first, unsigned last, unsigned modulus = 0);

    private:

        unsigned        GetTokenValue();

        NxsBlock        &block;     /* reference to the block object used for looking up labels */
        NxsToken        &token;     /* reference to the token being used to parse the NEXUS data file */
        NxsUnsignedSet  &nxsset;    /* reference to the NxsUnsignedSet set being read */
        unsigned        max;        /* maximum number of elements in the set */
        unsigned        settype;    /* the type of set being read (see the NxsSetReaderEnum enumeration) */
    };

typedef NxsSetReader SetReader;

#endif

---