property.h
Go to the documentation of this file.
// -*- C++ -*-
// Module: Log4CPLUS
// File: property.h
// Created: 2/2002
// Author: Tad E. Smith
//
//
// Copyright 2002-2017 Tad E. Smith
//
// Licensed under the Apache License, Version 2.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.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef LOG4CPLUS_HELPERS_PROPERTY_HEADER_
#define LOG4CPLUS_HELPERS_PROPERTY_HEADER_
#include <log4cplus/config.hxx>
#if defined (LOG4CPLUS_HAVE_PRAGMA_ONCE)
#pragma once
#endif
#include <log4cplus/streams.h>
#include <log4cplus/tstring.h>
#include <map>
#include <vector>
namespace log4cplus {
namespace helpers {
class LOG4CPLUS_EXPORT Properties {
public:
enum PFlags
{
// These encoding related options occupy 2 bits of the flags
// and are mutually exclusive. These flags are synchronized
// with PCFlags in PropertyConfigurator.
fEncodingShift = 3
, fEncodingMask = 0x3
, fUnspecEncoding = (0 << fEncodingShift)
#if defined (LOG4CPLUS_HAVE_CODECVT_UTF8_FACET) && defined (UNICODE)
, fUTF8 = (1 << fEncodingShift)
#endif
#if (defined (LOG4CPLUS_HAVE_CODECVT_UTF16_FACET) || defined (_WIN32)) \
&& defined (UNICODE)
, fUTF16 = (2 << fEncodingShift)
#endif
#if defined (LOG4CPLUS_HAVE_CODECVT_UTF32_FACET) && defined (UNICODE)
, fUTF32 = (3 << fEncodingShift)
#endif
, fThrow = (1 << 5)
};
Properties();
explicit Properties(log4cplus::tistream& input);
explicit Properties(const log4cplus::tstring& inputFile, unsigned flags = 0);
virtual ~Properties();
// constants
static const tchar PROPERTIES_COMMENT_CHAR;
// methods
bool exists(const log4cplus::tstring& key) const;
bool exists(tchar const * key) const;
std::size_t size() const
{
return data.size();
}
log4cplus::tstring const & getProperty(const log4cplus::tstring& key) const;
log4cplus::tstring const & getProperty(tchar const * key) const;
log4cplus::tstring getProperty(const log4cplus::tstring& key,
const log4cplus::tstring& defaultVal) const;
std::vector<log4cplus::tstring> propertyNames() const;
void setProperty(const log4cplus::tstring& key, const log4cplus::tstring& value);
bool removeProperty(const log4cplus::tstring& key);
Properties getPropertySubset(const log4cplus::tstring& prefix) const;
bool getInt (int & val, log4cplus::tstring const & key) const;
bool getUInt (unsigned & val, log4cplus::tstring const & key) const;
bool getLong (long & val, log4cplus::tstring const & key) const;
bool getULong (unsigned long & val, log4cplus::tstring const & key) const;
bool getBool (bool & val, log4cplus::tstring const & key) const;
bool getString (log4cplus::tstring & val, log4cplus::tstring const & key) const;
protected:
// Types
typedef std::map<log4cplus::tstring, log4cplus::tstring> StringMap;
// Methods
void init(log4cplus::tistream& input);
// Data
StringMap data;
unsigned flags;
private:
template <typename StringType>
log4cplus::tstring const & get_property_worker (
StringType const & key) const;
template <typename ValType>
bool get_type_val_worker (ValType & val,
log4cplus::tstring const & key) const;
};
class LogLog;
bool
substVars (tstring & dest, const tstring & val,
Properties const & props, LogLog& loglog,
unsigned flags);
} // end namespace helpers
}
#endif // LOG4CPLUS_HELPERS_PROPERTY_HEADER_
log4cplus::helpers::LogLog
This class used to output log statements from within the log4cplus package.
Definition loglog.h:55
log4cplus::helpers::Properties
Definition property.h:43
log4cplus::helpers::Properties::StringMap
std::map< log4cplus::tstring, log4cplus::tstring > StringMap
Definition property.h:140
log4cplus::helpers::Properties::getProperty
log4cplus::tstring const & getProperty(tchar const *key) const
log4cplus::helpers::Properties::getLong
bool getLong(long &val, log4cplus::tstring const &key) const
log4cplus::helpers::Properties::flags
unsigned flags
Definition property.h:147
log4cplus::helpers::Properties::getProperty
log4cplus::tstring const & getProperty(const log4cplus::tstring &key) const
Searches for the property with the specified key in this property list.
log4cplus::helpers::Properties::setProperty
void setProperty(const log4cplus::tstring &key, const log4cplus::tstring &value)
Inserts value into this map indexed by key.
log4cplus::helpers::Properties::data
StringMap data
Definition property.h:146
log4cplus::helpers::Properties::getUInt
bool getUInt(unsigned &val, log4cplus::tstring const &key) const
log4cplus::helpers::Properties::size
std::size_t size() const
Returns the number of entries in this map.
Definition property.h:85
log4cplus::helpers::Properties::PFlags
PFlags
Definition property.h:46
log4cplus::helpers::Properties::fEncodingMask
@ fEncodingMask
Definition property.h:52
log4cplus::helpers::Properties::fThrow
@ fThrow
Definition property.h:64
log4cplus::helpers::Properties::fEncodingShift
@ fEncodingShift
Definition property.h:51
log4cplus::helpers::Properties::fUnspecEncoding
@ fUnspecEncoding
Definition property.h:53
log4cplus::helpers::Properties::getInt
bool getInt(int &val, log4cplus::tstring const &key) const
log4cplus::helpers::Properties::exists
bool exists(tchar const *key) const
log4cplus::helpers::Properties::Properties
Properties(log4cplus::tistream &input)
log4cplus::helpers::Properties::getULong
bool getULong(unsigned long &val, log4cplus::tstring const &key) const
log4cplus::helpers::Properties::~Properties
virtual ~Properties()
log4cplus::helpers::Properties::getString
bool getString(log4cplus::tstring &val, log4cplus::tstring const &key) const
log4cplus::helpers::Properties::getProperty
log4cplus::tstring getProperty(const log4cplus::tstring &key, const log4cplus::tstring &defaultVal) const
Searches for the property with the specified key in this property list.
log4cplus::helpers::Properties::init
void init(log4cplus::tistream &input)
log4cplus::helpers::Properties::Properties
Properties()
log4cplus::helpers::Properties::exists
bool exists(const log4cplus::tstring &key) const
Tests to see if key can be found in this map.
log4cplus::helpers::Properties::removeProperty
bool removeProperty(const log4cplus::tstring &key)
Removed the property index by key from this map.
log4cplus::helpers::Properties::propertyNames
std::vector< log4cplus::tstring > propertyNames() const
Returns all the keys in this property list.
log4cplus::helpers::Properties::getPropertySubset
Properties getPropertySubset(const log4cplus::tstring &prefix) const
Returns a subset of the "properties" whose keys start with "prefix".
log4cplus::helpers::Properties::getBool
bool getBool(bool &val, log4cplus::tstring const &key) const
log4cplus::helpers::Properties::Properties
Properties(const log4cplus::tstring &inputFile, unsigned flags=0)
log4cplus::helpers::Properties::PROPERTIES_COMMENT_CHAR
static const tchar PROPERTIES_COMMENT_CHAR
Definition property.h:73
config.hxx
log4cplus::helpers
Definition appender.h:50
log4cplus::helpers::substVars
bool substVars(tstring &dest, const tstring &val, Properties const &props, LogLog &loglog, unsigned flags)
log4cplus
Definition appender.h:46
log4cplus::tstring
std::basic_string< tchar > tstring
Definition tstring.h:39
log4cplus::tchar
char tchar
Definition tchar.h:56
log4cplus::tistream
std::basic_istream< tchar > tistream
Definition streams.h:41
streams.h
tstring.h
LOG4CPLUS_EXPORT
#define LOG4CPLUS_EXPORT
Definition win32.h:141