//

// PropertyFileConfiguration.h

//

// $Id: //poco/1.4/Util/include/Poco/Util/PropertyFileConfiguration.h#1 $

//

// Library: Util

// Package: Configuration

// Module: PropertyFileConfiguration

//

// Definition of the PropertyFileConfiguration class.

//

// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.

// and Contributors.

//

// SPDX-License-Identifier: BSL-1.0

//

#ifndef Util_PropertyFileConfiguration_INCLUDED

#define Util_PropertyFileConfiguration_INCLUDED

#include "Poco/Util/Util.h"

#include "Poco/Util/MapConfiguration.h"

#include <istream>

#include <ostream>

#include <list>

namespace Poco {

namespace Util {

class Util_API PropertyFileConfiguration: public MapConfiguration

/// This implementation of a Configuration reads properties

/// from a Java-style properties file.

///

/// The file syntax is implemented as follows.

/// - a line starting with a hash '#' or exclamation mark '!' is treated as a comment and ignored

/// - every other line denotes a property assignment in the form

/// <key> = <value> or

/// <key> : <value>

///

/// Keys and values may contain special characters represented by the following escape sequences:

/// - \t: tab (0x09)

/// - \n: line feed (0x0a)

/// - \r: carriage return (0x0d)

/// - \f: form feed (0x0c)

///

/// For every other sequence that starts with a backslash, the backslash is removed.

/// Therefore, the sequence \a would just yield an 'a'.

///

/// A value can spread across multiple lines if the last character in a line (the character

/// immediately before the carriage return or line feed character) is a single backslash.

///

/// Property names are case sensitive. Leading and trailing whitespace is

/// removed from both keys and values. A property name can neither contain

/// a colon ':' nor an equal sign '=' character.

{

public:

PropertyFileConfiguration();

/// Creates an empty PropertyFileConfiguration.

PropertyFileConfiguration(std::istream& istr, bool preserveComment = false);

/// Creates an PropertyFileConfiguration and loads the configuration data

/// from the given stream, which must be in properties file format.

/// Set the preserveComment to preserve the comments in the given stream.

PropertyFileConfiguration(const std::string& path, bool preserveComment = false);

/// Creates an PropertyFileConfiguration and loads the configuration data

/// from the given file, which must be in properties file format.

/// Set the preserveComment to preserve the comments in the given stream.

void load(std::istream& istr, bool preserveComment = false);

/// Loads the configuration data from the given stream, which

/// must be in properties file format.

/// Set the preserveComment to preserve the comments in the given stream.

void load(const std::string& path, bool preserveComment = false);

/// Loads the configuration data from the given file, which

/// must be in properties file format.

/// Set the preserveComment to preserve the comments in the given stream.

void save(std::ostream& ostr) const;

/// Writes the configuration data to the given stream.

///

/// The data is written as a sequence of statements in the form

/// <key>: <value>

/// separated by a newline character.

void save(const std::string& path) const;

/// Writes the configuration data to the given file.

protected:

void setRaw(const std::string& key, const std::string& value);

void removeRaw(const std::string& key);

~PropertyFileConfiguration();

private:

typedef std::list<std::string> FileContent;

typedef std::map<std::string, FileContent::iterator> KeyFileContentItMap;

void parseLine(std::istream& istr);

void skipSpace(std::istream& istr) const;

bool isComment(int c) const ;

void saveComment(std::istream& istr);

void skipLine(std::istream& istr) const;

void saveKeyValue(std::istream& istr);

bool isNewLine(int c) const;

bool isKeyValueSeparator(int c) const;

std::string composeOneLine(const std::string& key, const std::string& value) const;

bool _preserveComment;

FileContent _fileContent;

KeyFileContentItMap _keyFileContentItMap;

static int readChar(std::istream& istr);

};

} } // namespace Poco::Util

#endif // Util_PropertyFileConfiguration_INCLUDED