IniFile.h

Go to the documentation of this file.

//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Project: uLib - User mode utility library.
// Module: INI file support class. (Ini files are portable, registry is not.)
// Author: Copyright (c) Love Nystrom
// License: NNOSL (BSD descendant, see NNOSL.txt in the base directory).
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

// Note: Due to my unwillingness to swell the header too much vertically, which
// would hamper overview, the doxygen comments result in long lines instead.

#ifndef _IniFile_h_incl_
#define _IniFile_h_incl_

#include <uLib/Common.h>


typedef class IniFile* PIniFile;
//
//
class IniFile {
protected:
    PBYTE _buffer;
    UINT  _bufSize;
    INT   _valSize; // Negative = Buffer insufficient on last call.
public:
    TCHAR    Filename[ MAX_PATH ]; 
    UINT_PTR UserData; 


    IniFile( CSTR FName=NULL, UINT BufSize=4096 );
    virtual ~IniFile(); 

    
    void  SetFilename( CSTR FName );


    bool  AllocBuffer( UINT Size );
    UINT  BufSize()   { return _bufSize; } 
    PBYTE GetBuffer() { return _buffer; } 

    // Ini files are typically ANSI (char) text files.
    // TODO: Check how ini functions react to wchar_t files..

    operator LPCSTR() { return (LPCSTR)_buffer; } 
    operator LPSTR()  { return (LPSTR)_buffer; } 


    INT   ValSize() { return _valSize; }

    UINT  GetInt( CSTR Section, CSTR KeyName, INT Default ); 
    INT   GetString( CSTR Section, CSTR KeyName, CSTR Default, TSTR Buf, UINT BufLen ); 
    TSTR  GetString( CSTR Section, CSTR KeyName, CSTR Default, OPTOUT INT* Size = NULL ); 
    TSTR  GetSection( CSTR Section, OPTOUT INT* Size = NULL ); 
    TSTR  GetSectionNames( OPTOUT INT* Size = NULL ); 

    
    PBYTE GetBinary( CSTR Section, CSTR Key, OUT INT* pSize );
    PBYTE GetStruct( CSTR Section, CSTR Key, UINT cbStruct );


    BOOL WriteRawSection( CSTR Section, CSTR MultiSz );
    BOOL WriteSection( CSTR Section, CSTR Strings ); 
    BOOL WriteString( CSTR Section, CSTR KeyName, CSTR Text ); 
    

    BOOL WriteStringFmt( CSTR Section, CSTR KeyName, CSTR Fmt, ... );

    BOOL WriteInt( CSTR Section, CSTR KeyName, LONG Value, BYTE Radix=10 ); 
    BOOL WriteStruct( CSTR Section, CSTR Key, PVOID pStruct, UINT Size ); 

    BOOL DeleteString( CSTR Section, CSTR KeyName ); 
    BOOL DeleteSection( CSTR Section ); 

    // Common chores..

    BOOL SaveWndRect( HWND hWnd, CSTR Section, CSTR Key ); 
    BOOL RestoreWndRect( HWND hWnd, CSTR Section, CSTR Key ); 
};

#endif//ndef _IniFile_h_incl_
// EOF