mirror of
https://github.com/FirebirdSQL/firebird.git
synced 2025-02-01 20:00:38 +01:00
96 lines
3.1 KiB
C
96 lines
3.1 KiB
C
|
/*
|
||
|
|
* PROGRAM: Client/Server Common Code
|
||
|
|
* MODULE: config.h
|
||
|
|
* DESCRIPTION: Configuration manager (public interface)
|
||
|
|
*
|
||
|
|
* The contents of this file are subject to the Interbase Public
|
||
|
|
* License Version 1.0 (the "License"); you may not use this file
|
||
|
|
* except in compliance with the License. You may obtain a copy
|
||
|
|
* of the License at http://www.Inprise.com/IPL.html
|
||
|
|
*
|
||
|
|
* Software distributed under the License is distributed on an
|
||
|
|
* "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express
|
||
|
|
* or implied. See the License for the specific language governing
|
||
|
|
* rights and limitations under the License.
|
||
|
|
*
|
||
|
|
* The Original Code was created by Inprise Corporation
|
||
|
|
* and its predecessors. Portions created by Inprise Corporation are
|
||
|
|
* Copyright (C) Inprise Corporation.
|
||
|
|
*
|
||
|
|
* Created by: Dmitry Yemanov <yemanov@yandex.ru>
|
||
|
|
*
|
||
|
|
* All Rights Reserved.
|
||
|
|
* Contributor(s): ______________________________________.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef CONFIG_H
|
||
|
|
#define CONFIG_H
|
||
|
|
|
||
|
|
#include "fb_string.h"
|
||
|
|
#include "fb_vector.h"
|
||
|
|
|
||
|
|
/**
|
||
|
|
Since the original (isc.cpp) code wasn't able to provide powerful and
|
||
|
|
easy-to-use abilities to work with complex configurations, a decision
|
||
|
|
has been made to create a completely new one.
|
||
|
|
|
||
|
|
This class is a public interface for our generic configuration manager
|
||
|
|
and allows to access all configuration values by its getXXX() member
|
||
|
|
functions. Each of these functions corresponds to one and only one key
|
||
|
|
and has one input argument - default value, which is used when the
|
||
|
|
requested key is missing or the configuration file is not found. Supported
|
||
|
|
value datatypes are "string", "int" and "bool". Usual default values for
|
||
|
|
these datatypes are empty string, zero and false respectively. There are
|
||
|
|
two types of member functions - scalar and vector. The former ones return
|
||
|
|
single value of the given type. The latter ones return vector which
|
||
|
|
contains an ordered array of values.
|
||
|
|
|
||
|
|
There's one exception - getRootDirectory() member function, which returns
|
||
|
|
root pathname of the current installation. This value isn't stored in the
|
||
|
|
configuration file, but is managed by the code itself.
|
||
|
|
|
||
|
|
To add new configuration item, you have to take the following steps:
|
||
|
|
|
||
|
|
1. Add physical key to keys[] array (config.cpp)
|
||
|
|
2. Add logical key to ConfigKey enumeration (config_impl.h)
|
||
|
|
(note: both physical and logical keys MUST have the same ordinal
|
||
|
|
position within appropriate structures)
|
||
|
|
3. Add member function to Config class (config.h) and implement it
|
||
|
|
in config.cpp module.
|
||
|
|
**/
|
||
|
|
|
||
|
|
class Config
|
||
|
|
{
|
||
|
|
typedef Firebird::string string;
|
||
|
|
typedef Firebird::vector<string> string_vector;
|
||
|
|
|
||
|
|
public:
|
||
|
|
|
||
|
|
/*
|
||
|
|
Root directory of current installation
|
||
|
|
*/
|
||
|
|
static string getRootDirectory();
|
||
|
|
|
||
|
|
/*
|
||
|
|
Block size for the sorting manager
|
||
|
|
*/
|
||
|
|
static int getSortMemBlockSize(int default_value = 0);
|
||
|
|
|
||
|
|
/*
|
||
|
|
Memory usage limit for the sorting manager
|
||
|
|
*/
|
||
|
|
static int getSortMemUpperLimit(int default_value = 0);
|
||
|
|
|
||
|
|
/*
|
||
|
|
Whether remote (NFS) files can be opened
|
||
|
|
*/
|
||
|
|
static bool getRemoteFileOpenAbility(bool default_value = false);
|
||
|
|
|
||
|
|
/*
|
||
|
|
List of directories to store temporary files in
|
||
|
|
*/
|
||
|
|
static string_vector getTempDirectories(string default_value = "");
|
||
|
|
};
|
||
|
|
|
||
|
|
#endif // CONFIG_H
|