fastformat/bundles/properties_bundle.hpp

Go to the documentation of this file.

/* /////////////////////////////////////////////////////////////////////////
 * File:        fastformat/bundles/properties_bundle.hpp
 *
 * Purpose:     .properties file bundle.
 *
 * Created:     19th September 2006
 * Updated:     19th May 2010
 *
 * Home:        http://www.fastformat.org/
 *
 * Copyright (c) 2007-2010, Matthew Wilson and Synesis Software
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - Neither the names of Matthew Wilson and Synesis Software nor the names
 *   of any contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * ////////////////////////////////////////////////////////////////////// */


#ifndef FASTFORMAT_INCL_FASTFORMAT_BUNDLES_HPP_PROPERTIES_BUNDLE
#define FASTFORMAT_INCL_FASTFORMAT_BUNDLES_HPP_PROPERTIES_BUNDLE

/* /////////////////////////////////////////////////////////////////////////
 * Version information
 */

#ifndef FASTFORMAT_DOCUMENTATION_SKIP_SECTION
# define FASTFORMAT_VER_FASTFORMAT_BUNDLES_HPP_PROPERTIES_BUNDLE_MAJOR      1
# define FASTFORMAT_VER_FASTFORMAT_BUNDLES_HPP_PROPERTIES_BUNDLE_MINOR      1
# define FASTFORMAT_VER_FASTFORMAT_BUNDLES_HPP_PROPERTIES_BUNDLE_REVISION   4
# define FASTFORMAT_VER_FASTFORMAT_BUNDLES_HPP_PROPERTIES_BUNDLE_EDIT       16
#endif /* !FASTFORMAT_DOCUMENTATION_SKIP_SECTION */

/* /////////////////////////////////////////////////////////////////////////
 * Language
 */

#ifndef __cplusplus
# error This file can only be included in C++ compilation units
#endif /* !__cplusplus */

/* /////////////////////////////////////////////////////////////////////////
 * Includes
 */

/* FastFormat Header Files */
#include <fastformat/fastformat.h>
//#include <fastformat/exceptions.hpp>

/* STLSoft Header Files */
#include <stlsoft/shims/access/string.hpp>
#include <stlsoft/string/split_functions.hpp>
#include <stlsoft/string/trim_functions.hpp>

/* C++ Standard Header Files */
#include <fstream>
#include <map>
#include <stdexcept>
#include <string>

/* /////////////////////////////////////////////////////////////////////////
 * Namespace
 */

#if !defined(FASTFORMAT_NO_NAMESPACE)
namespace fastformat
{
#endif /* !FASTFORMAT_NO_NAMESPACE */

/* /////////////////////////////////////////////////////////////////////////
 * Classes
 */

class properties_bundle
{
public:
    typedef std::string                         string_type;
    typedef properties_bundle                   class_type;
private:
    typedef std::map<string_type, string_type>  map_type;

public:
    enum
    {
            ignoreCaseOnLookup  =   0x01
        ,   treatSourceAsMemory =   0x02
    };

public:
    explicit properties_bundle(char const *source);

    template <typename S>
    explicit properties_bundle(S const& source)
        : m_properties(open_ns_(source))
    {}

    ~properties_bundle() throw();

public:
    string_type operator [](char const* name) const throw(std::out_of_range);
    template <typename S>
    string_type operator [](S const& name) const throw(std::out_of_range)
    {
        FASTFORMAT_DECLARE_c_str_ptr_();

        return operator [](FASTFORMAT_INVOKE_c_str_ptr_(FASTFORMAT_INVOKE_c_str_ptr_(name)));
    }

private:
    // We have to have this funky level of indirection due to DMC++ and GCC compilers'
    // weird behaviour wrt handling shims' fully qualified names in templates.
    template <typename S>
    static const map_type open_ns_(S const& source)
    {
        FASTFORMAT_DECLARE_c_str_ptr_();

        return open_(FASTFORMAT_INVOKE_c_str_ptr_(source));
    }

    static const map_type open_(char const *name);

private:
    map_type const m_properties;

private:
    properties_bundle(class_type const&);
    class_type& operator =(class_type const&);
};

/* /////////////////////////////////////////////////////////////////////////
 * Implementation
 */

#ifndef FASTFORMAT_DOCUMENTATION_SKIP_SECTION

inline /* static */ const properties_bundle::map_type properties_bundle::open_(char const *name)
{
// TODO: Change this to use the new STLSoft properties_file class, when 1.10 comes out

    std::string     line;
    std::ifstream   stm(name);
    map_type        map;

    if(!stm)
    {
// TODO: Define (and thoroughly unit-test) a FastFormat-specific exception, and use that instead

        throw std::runtime_error("properties file not found");
    }

    for(; std::getline(stm, line); )
    {
        std::string name;
        std::string value;

        stlsoft::trim_all(line);

        if(stlsoft::split(line, '=', name, value))
        {
            stlsoft::trim_all(name);
            stlsoft::trim_left(value);

            map[name] = value;
        }
    }

    return map;
}


inline properties_bundle::properties_bundle(char const *source)
    : m_properties(open_(source))
{}

inline properties_bundle::~properties_bundle() throw()
{}

inline properties_bundle::string_type properties_bundle::operator [](char const *name) const throw(std::out_of_range)
{
    map_type::const_iterator it = m_properties.find(name);

    if(it == m_properties.end())
    {
        throw std::out_of_range("format string not found");
    }

    return (*it).second;
}

#endif /* FASTFORMAT_DOCUMENTATION_SKIP_SECTION */

/* /////////////////////////////////////////////////////////////////////////
 * Namespace
 */

#if !defined(FASTFORMAT_NO_NAMESPACE)
} /* namespace fastformat */
#endif /* !FASTFORMAT_NO_NAMESPACE */

/* ////////////////////////////////////////////////////////////////////////// */

#endif /* FASTFORMAT_INCL_FASTFORMAT_BUNDLES_HPP_PROPERTIES_BUNDLE */

/* ///////////////////////////// end of file //////////////////////////// */

FastFormat Library documentation © Matthew Wilson, 2006-2009