import comment
git-svn-id: https://svn.code.sf.net/p/keepassx/code/trunk@1 b624d157-de02-0410-bad0-e51aec6abb33
This commit is contained in:
180
src/lib/IniReader.h
Executable file
180
src/lib/IniReader.h
Executable file
@@ -0,0 +1,180 @@
|
||||
// IniFile.cpp: Implementation of the CIniFile class.
|
||||
// Written by: Adam Clauss
|
||||
// Email: cabadam@tamu.edu
|
||||
// You may use this class/code as you wish in your programs. Feel free to distribute it, and
|
||||
// email suggested changes to me.
|
||||
//
|
||||
// Rewritten by: Shane Hill
|
||||
// Date: 21/08/2001
|
||||
// Email: Shane.Hill@dsto.defence.gov.au
|
||||
// Reason: Remove dependancy on MFC. Code should compile on any
|
||||
// platform. Tested on Windows/Linux/Irix
|
||||
//////////////////////////////////////////////////////////////////////
|
||||
|
||||
#ifndef CIniFile_H
|
||||
#define CIniFile_H
|
||||
using namespace std;
|
||||
// C++ Includes
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
// C Includes
|
||||
#include <stdlib.h>
|
||||
|
||||
#define MAX_KEYNAME 128
|
||||
#define MAX_VALUENAME 128
|
||||
#define MAX_VALUEDATA 2048
|
||||
|
||||
class CIniFile
|
||||
{
|
||||
private:
|
||||
bool caseInsensitive;
|
||||
string path;
|
||||
struct key {
|
||||
vector<string> names;
|
||||
vector<string> values;
|
||||
vector<string> comments;
|
||||
};
|
||||
vector<key> keys;
|
||||
vector<string> names;
|
||||
vector<string> comments;
|
||||
string CheckCase( string s) const;
|
||||
|
||||
public:
|
||||
enum errors{ noID = -1};
|
||||
CIniFile( string const iniPath = "");
|
||||
virtual ~CIniFile() {}
|
||||
|
||||
// Sets whether or not keynames and valuenames should be case sensitive.
|
||||
// The default is case insensitive.
|
||||
void CaseSensitive() {caseInsensitive = false;}
|
||||
void CaseInsensitive() {caseInsensitive = true;}
|
||||
|
||||
// Sets path of ini file to read and write from.
|
||||
void Path(string const newPath) {path = newPath;}
|
||||
string Path() const {return path;}
|
||||
void SetPath(string const newPath) {Path( newPath);}
|
||||
|
||||
// Reads ini file specified using path.
|
||||
// Returns true if successful, false otherwise.
|
||||
bool ReadFile();
|
||||
|
||||
// Writes data stored in class to ini file.
|
||||
bool WriteFile();
|
||||
|
||||
// Deletes all stored ini data.
|
||||
void Erase();
|
||||
void Clear() {Erase();}
|
||||
void Reset() {Erase();}
|
||||
|
||||
// Returns index of specified key, or noID if not found.
|
||||
long FindKey( string const keyname) const;
|
||||
|
||||
// Returns index of specified value, in the specified key, or noID if not found.
|
||||
long FindValue( unsigned const keyID, string const valuename) const;
|
||||
|
||||
// Returns number of keys currently in the ini.
|
||||
unsigned NumKeys() const {return names.size();}
|
||||
unsigned GetNumKeys() const {return NumKeys();}
|
||||
|
||||
// Add a key name.
|
||||
unsigned AddKeyName( string const keyname);
|
||||
|
||||
// Returns key names by index.
|
||||
string KeyName( unsigned const keyID) const;
|
||||
string GetKeyName( unsigned const keyID) const {return KeyName(keyID);}
|
||||
|
||||
// Returns number of values stored for specified key.
|
||||
unsigned NumValues( unsigned const keyID);
|
||||
unsigned GetNumValues( unsigned const keyID) {return NumValues( keyID);}
|
||||
unsigned NumValues( string const keyname);
|
||||
unsigned GetNumValues( string const keyname) {return NumValues( keyname);}
|
||||
|
||||
// Returns value name by index for a given keyname or keyID.
|
||||
string ValueName( unsigned const keyID, unsigned const valueID) const;
|
||||
string GetValueName( unsigned const keyID, unsigned const valueID) const {
|
||||
return ValueName( keyID, valueID);
|
||||
}
|
||||
string ValueName( string const keyname, unsigned const valueID) const;
|
||||
string GetValueName( string const keyname, unsigned const valueID) const {
|
||||
return ValueName( keyname, valueID);
|
||||
}
|
||||
|
||||
// Gets value of [keyname] valuename =.
|
||||
// Overloaded to return string, int, and double.
|
||||
// Returns defValue if key/value not found.
|
||||
string GetValue( unsigned const keyID, unsigned const valueID, string const defValue = "") const;
|
||||
string GetValue(string const keyname, string const valuename, string const defValue = "") const;
|
||||
int GetValueI(string const keyname, string const valuename, int const defValue = 0) const;
|
||||
bool GetValueB(string const keyname, string const valuename, bool const defValue = false) const {
|
||||
return bool( GetValueI( keyname, valuename, int( defValue)));
|
||||
}
|
||||
double GetValueF(string const keyname, string const valuename, double const defValue = 0.0) const;
|
||||
// This is a variable length formatted GetValue routine. All these voids
|
||||
// are required because there is no vsscanf() like there is a vsprintf().
|
||||
// Only a maximum of 8 variable can be read.
|
||||
unsigned GetValueV( string const keyname, string const valuename, char *format,
|
||||
void *v1 = 0, void *v2 = 0, void *v3 = 0, void *v4 = 0,
|
||||
void *v5 = 0, void *v6 = 0, void *v7 = 0, void *v8 = 0,
|
||||
void *v9 = 0, void *v10 = 0, void *v11 = 0, void *v12 = 0,
|
||||
void *v13 = 0, void *v14 = 0, void *v15 = 0, void *v16 = 0);
|
||||
|
||||
// Sets value of [keyname] valuename =.
|
||||
// Specify the optional paramter as false (0) if you do not want it to create
|
||||
// the key if it doesn't exist. Returns true if data entered, false otherwise.
|
||||
// Overloaded to accept string, int, and double.
|
||||
bool SetValue( unsigned const keyID, unsigned const valueID, string const value);
|
||||
bool SetValue( string const keyname, string const valuename, string const value, bool const create = true);
|
||||
bool SetValueI( string const keyname, string const valuename, int const value, bool const create = true);
|
||||
bool SetValueB( string const keyname, string const valuename, bool const value, bool const create = true) {
|
||||
return SetValueI( keyname, valuename, int(value), create);
|
||||
}
|
||||
bool SetValueF( string const keyname, string const valuename, double const value, bool const create = true);
|
||||
bool SetValueV( string const keyname, string const valuename, char *format, ...);
|
||||
|
||||
// Deletes specified value.
|
||||
// Returns true if value existed and deleted, false otherwise.
|
||||
bool DeleteValue( string const keyname, string const valuename);
|
||||
|
||||
// Deletes specified key and all values contained within.
|
||||
// Returns true if key existed and deleted, false otherwise.
|
||||
bool DeleteKey(string keyname);
|
||||
|
||||
// Header comment functions.
|
||||
// Header comments are those comments before the first key.
|
||||
//
|
||||
// Number of header comments.
|
||||
unsigned NumHeaderComments() {return comments.size();}
|
||||
// Add a header comment.
|
||||
void HeaderComment( string const comment);
|
||||
// Return a header comment.
|
||||
string HeaderComment( unsigned const commentID) const;
|
||||
// Delete a header comment.
|
||||
bool DeleteHeaderComment( unsigned commentID);
|
||||
// Delete all header comments.
|
||||
void DeleteHeaderComments() {comments.clear();}
|
||||
|
||||
// Key comment functions.
|
||||
// Key comments are those comments within a key. Any comments
|
||||
// defined within value names will be added to this list. Therefore,
|
||||
// these comments will be moved to the top of the key definition when
|
||||
// the CIniFile::WriteFile() is called.
|
||||
//
|
||||
// Number of key comments.
|
||||
unsigned NumKeyComments( unsigned const keyID) const;
|
||||
unsigned NumKeyComments( string const keyname) const;
|
||||
// Add a key comment.
|
||||
bool KeyComment( unsigned const keyID, string const comment);
|
||||
bool KeyComment( string const keyname, string const comment);
|
||||
// Return a key comment.
|
||||
string KeyComment( unsigned const keyID, unsigned const commentID) const;
|
||||
string KeyComment( string const keyname, unsigned const commentID) const;
|
||||
// Delete a key comment.
|
||||
bool DeleteKeyComment( unsigned const keyID, unsigned const commentID);
|
||||
bool DeleteKeyComment( string const keyname, unsigned const commentID);
|
||||
// Delete all comments for a key.
|
||||
bool DeleteKeyComments( unsigned const keyID);
|
||||
bool DeleteKeyComments( string const keyname);
|
||||
};
|
||||
|
||||
#endif
|
||||
Reference in New Issue
Block a user