registry.h

来自「这是VCF框架的代码」· C头文件 代码 · 共 313 行

#ifndef _VCF_REGISTRY_H__
#define _VCF_REGISTRY_H__
//Registry.h

/*
Copyright 2000-2004 The VCF Project.
Please see License.txt in the top level directory
where you installed the VCF.
*/


#if _MSC_VER > 1000
#   pragma once
#endif


namespace VCF {

enum RegistryKeyType{
	RKT_ROOT=0,
	RKT_CURRENT_USER,
	RKT_LOCAL_MACHINE
};

enum RegistryDataType{
	RDT_STRING = 0,
	RDT_INTEGER,
	RDT_BOOL,
	RDT_BINARY
};

/**
\class RegistryValueInfo Registry.h "vcf/FoundationKit/Registry.h"
*/
class FOUNDATIONKIT_API RegistryException : public RuntimeException {
public:
	RegistryException( const VCF::String & message ):
		RuntimeException( message ){

	};
		
	RegistryException( const VCF::String & message, const int lineNumber ):
		VCF::RuntimeException(message, lineNumber){};

	virtual ~RegistryException() throw() {};

};

/**
\class RegistryValueInfo Registry.h "vcf/FoundationKit/Registry.h"
*a class that wraps up a specific registry value that may
*be a string, integer, bool, or stream of binary data
*/
class FOUNDATIONKIT_API RegistryValueInfo : public Object {
public:

	RegistryValueInfo( const VariantData* data, const RegistryDataType& dataType,
		               const String& valueName, char* dataBuffer=NULL, const uint32& dataBufferSize=0  ){

		dataType_ = dataType;

		valueName_ = valueName;

		dataBufferSize_ = dataBufferSize;

		dataBuffer_ = NULL;

		if ( NULL != data ){
			switch ( dataType_ ){
				case RDT_STRING :{
					data_ = (String)*data;
				}
				break;

				case RDT_INTEGER :{
					data_ = (ulong32)*data;
				}
				break;

				case RDT_BOOL :{
					data_ = (bool)(*data);
				}
				break;

				case RDT_BINARY :{
					dataBuffer_ = dataBuffer;
				}
				break;
			}
		}
	}


	virtual ~RegistryValueInfo(){
		if ( NULL != dataBuffer_ ){
			delete dataBuffer_;
		}
	}

	RegistryDataType dataType_;

	VariantData data_;

	String valueName_;

	char* dataBuffer_;

	uint32 dataBufferSize_;
};



class RegistryPeer;

/**
\class Registry Registry.h "vcf/FoundationKit/Registry.h"
*The registry represents an external data source that applications
*may store application data in. This may be things like special file names,
*UI positions, application state data etc. The external data may be anything
*depending on the OS. In Win32, this represents a connection to the
*Win32 registry data base.
*/
class FOUNDATIONKIT_API Registry  : public Object{

public:
	Registry();

	virtual ~Registry();

	void setRoot( const RegistryKeyType& rootKey );

	RegistryKeyType getRoot();

	bool openKey( const String& keyname, const bool& createIfNonExistant=false );

	bool setValue( const String& value, const String& valuename );

	bool setValue( const uint32& value, const String& valuename );

	bool setValue( const bool& value, const String& valuename );

	bool setValue( void* dataBuffer, const uint32& dataBufferSize, const String& valuename );

	/**
	Returns a named string value from the registry and the
	current open key. If no such value name exists, or there 
	is some other problem reading the value, the function throws 
	a RegistryException exception.
	@param String the name of the value under the current open key
	@return String the value returned
	*/
	String getStringValue( const String& valuename );

	/**
	Returns a named int value from the registry and the
	current open key. If no such value name exists, or there 
	is some other problem reading the value, the function throws 
	a RegistryException exception.
	@param String the name of the value under the current open key
	@return uint32 the value returned
	*/
	uint32 getIntValue( const String& valuename );

	/**
	Returns a named bool value from the registry and the
	current open key. If no such value name exists, or there 
	is some other problem reading the value, the function throws 
	a RegistryException exception.
	@param String the name of the value under the current open key
	@return bool the value returned
	*/
	bool getBoolValue( const String& valuename );

	/**
	Returns a named data buffer from the registry and the
	current open key. If no such value name exists, or there 
	is some other problem reading the value, the function throws 
	a RegistryException exception.
	
	Note that the function allocates a data buffer for the caller,
	however it is the caller's responsibility to delete the 
	data buffer when the caller is finished with it.
	Example usage
	\code
	Registry reg; 
	//reg already opened to some key...

	void* buf = NULL;
	uint32 dataBufferSize = 0;
	try {
		reg.getDataBufValue( "MyData", dataBufferSize, &buf );
	}
	catch ( RegistryException& ) {
		System::println( "Oops - an error occured!" );
	}

	//do stuff with buffer ...

	//clean up buffer - delete it!
	delete buf; 
	\endcode
	@param String the name of the value under the current open key
	@param uint32 the size of the newly allocated  data buffer in bytes
	@param void** a pointer to a data buffer pointer.
	*/
	void getDataBufValue( const String& valuename, uint32& dataBufferSize, void** dataBuffer );

	Enumerator<String>* getKeyNames();

	Enumerator<RegistryValueInfo*>* getValues();

	String getCurrentKey();
private:
	RegistryPeer* peer_;
};

}; //end of namespace VCF


/**
*CVS Log info
*$Log$
*Revision 1.5  2006/04/07 02:35:35  ddiego
*initial checkin of merge from 0.6.9 dev branch.
*
*Revision 1.4.2.4  2006/03/26 22:37:35  ddiego
*minor update to source docs.
*
*Revision 1.4.2.3  2006/03/12 22:01:40  ddiego
*doc updates.
*
*Revision 1.4.2.2  2005/09/05 18:26:59  ddiego
*adjusted reg class methods for reading data so that they now throw
*exceptions for bad reads.
*
*Revision 1.4.2.1  2005/09/05 18:17:17  ddiego
*adjusted reg class methods for reading data so that they now throw
*exceptions for bad reads.
*
*Revision 1.4  2005/07/09 23:15:04  ddiego
*merging in changes from devmain-0-6-7 branch.
*
*Revision 1.3  2005/01/02 03:04:23  ddiego
*merged over some of the changes from the dev branch because they're important resoource loading bug fixes. Also fixes a few other bugs as well.
*
*Revision 1.2.4.1  2004/12/24 00:59:28  marcelloptr
*VariantData::toString() made const
*
*Revision 1.2.4.1  2004/12/24 00:59:28  marcelloptr
*VariantData::toString() made const
*
*Revision 1.2  2004/08/07 02:49:14  ddiego
*merged in the devmain-0-6-5 branch to stable
*
*Revision 1.1.2.3  2004/06/06 07:05:33  marcelloptr
*changed macros, text reformatting, copyright sections
*
*Revision 1.1.2.2  2004/04/29 04:07:13  marcelloptr
*reformatting of source files: macros and csvlog and copyright sections
*
*Revision 1.1.2.1  2004/04/28 03:29:40  ddiego
*migration towards new directory structure
*
*Revision 1.10.2.1  2004/04/26 21:58:48  marcelloptr
*changes for dir reorganization: _VCF_MACRO_H__
*
*Revision 1.10  2004/01/20 01:54:55  ddiego
*merged some more changes from dev branch, primarily changes to
*teh RTTI API so that we now process enum sets correctly (i.e. a long
*that is a mask made of enum values).
*
*Revision 1.9.2.1  2004/01/18 04:52:46  ddiego
*Added a new EnumSet class that handles manipulating unsigned longs
*as a mask of bits. Adds support for reading in the enum value names and
*ORing them together to form the complete mask value. Also made
*mods to the VFFOutput and VFFInput stream classes so that that the []
*property is correctly read and written
*
*Revision 1.9  2003/12/18 05:15:59  ddiego
*merge from devmain-0-6-2 branch into the stable branch
*
*Revision 1.8.4.1  2003/10/23 04:24:51  ddiego
*more musical chairs with headers again, in yet another attempt to make
*them more efficent to speed up compiles.
*Removed all teh template RTTI classes and put them all in one header
*called VCFRTTIImpl.h. This should help compile speeds a bit.
*The next step is to look at some of the event classes and remove ones
*that aren't really neccessary - I'd estimate that 50% of the current
*event classes are unneccessary and can be removed.
*
*Revision 1.8  2003/05/17 20:37:17  ddiego
*this is the checkin for the 0.6.1 release - represents the merge over from
*the devmain-0-6-0 branch plus a few minor bug fixes
*
*Revision 1.7.22.1  2003/03/12 03:11:51  ddiego
*switched all member variable that used the "m_"<name> prefix to
* <name>"_" suffix nameing standard.
*Also changed all vcf builder files to accomadate this.
*Changes were made to the Stream classes to NOT multiple inheritance and to
*be a little more correct. Changes include breaking the FileStream into two
*distinct classes, one for input and one for output.
*
*Revision 1.7  2002/01/24 01:46:49  ddiego
*added a cvs "log" comment to the top of all files in vcf/src and vcf/include
*to facilitate change tracking
*
*/


#endif // _VCF_REGISTRY_H__