/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011  Cyan Worlds, Inc.

This program 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 3 of the License, or
(at your option) any later version.

This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
 or by snail mail at:
      Cyan Worlds, Inc.
      14617 N Newport Hwy
      Mead, WA   99021

*==LICENSE==*/
#ifndef PLLOC_H
#define PLLOC_H

#include "HeadSpin.h"
#include "hsUtils.h"


// Values for UOID, such as AGE, District Room
// Are kept in configuration file(s)
// Levels are defined by the number of TABS in front of a string.
const int LOC_EOF = -1;

    // plLocFileParser Is a utility class used by plRegistry to Parse the Location.txt
    // configuration file.

#if HS_BUILD_FOR_WIN32
#define LOCTXTFILE "c:\\Location.txt"
#else
#define LOCTXTFILE "./Location.txt"
#endif

class plLocFileParser
{
public:
    plLocFileParser();
    ~plLocFileParser()              { if (fpFile) fclose(fpFile); fpFile = 0; }
    void    ThrowBack(char *p,UInt8 lev) { fThrowBack = p; fThrowBackLevel = lev; }
    void    ClearThrowBack()        { fThrowBack = NULL; fThrowBackLevel = 0; }
    bool    ThrowBackAvailable()    { return (fThrowBack == NULL) ? false: true; }
    int NextLine(char **pP); // returns an Allocated string in pP of next valid line, and Level #, or LOC_EOF
    hsBool8 Ready()                 {   return fpFile ? true: false; }
private:
    FILE *  fpFile;
    char *  fThrowBack;         // If a line is not used, it can be thrown back...unget()
    int fThrowBackLevel;
};


#endif