PolicyFile.h

Go to the documentation of this file.

// -*- lsst-c++ -*-

/*
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */

#ifndef LSST_PEX_POLICY_FILE_H
#define LSST_PEX_POLICY_FILE_H

#include <memory>
#include <boost/regex.hpp>
#include <boost/filesystem/path.hpp>
#include <boost/filesystem/operations.hpp>

#include "lsst/pex/policy/PolicySource.h"
#include "lsst/pex/policy/SupportedFormats.h"
#include "lsst/daf/base/Persistable.h"

namespace lsst {
namespace pex {
namespace policy {

class PolicyFile : public PolicySource, public lsst::daf::base::Persistable {
public:

    explicit PolicyFile(const std::string& filepath, const SupportedFormats::Ptr& fmts = defaultFormats);
    explicit PolicyFile(const char* filepath, const SupportedFormats::Ptr& fmts = defaultFormats);
    explicit PolicyFile(const boost::filesystem::path& filepath,
                        const SupportedFormats::Ptr& fmts = defaultFormats);


    PolicyFile(const std::string& filepath, const PolicyParserFactory::Ptr& parserFactory);
    PolicyFile(const boost::filesystem::path& filepath, const PolicyParserFactory::Ptr& parserFactory);


    PolicyFile(const std::string& filepath, const boost::filesystem::path& reposDir,
               const SupportedFormats::Ptr& fmts = defaultFormats);
    PolicyFile(const boost::filesystem::path& filepath, const boost::filesystem::path& reposDir,
               const SupportedFormats::Ptr& fmts = defaultFormats);


    PolicyFile(const std::string& filepath, const boost::filesystem::path& reposDir,
               const PolicyParserFactory::Ptr& parserFactory);
    PolicyFile(const boost::filesystem::path& filepath, const boost::filesystem::path& reposDir,
               const PolicyParserFactory::Ptr& parserFactory);

    PolicyFile(const SupportedFormats::Ptr& fmts = defaultFormats);

    //     /*
    //      * determine the format that the data is stored in and return its format
    //      * type identifier.  Note that UNKNOWN will be returned
    //      * if the format is supported--that is, the data can be read into a
    //      * Policy object--but otherwise does not have a defined type identifier
    //      * defined.  This may cause the first few records of the source to
    //      * be read.
    //      * @exception IOError   if an error occurs while reading the first few
    //      *                      characters of the source stream.
    //      */
    //     virtual FormatType getFormatType();

    const std::string getPath() const { return _file.string(); }

    bool exists() const { return boost::filesystem::exists(_file); }

    virtual const std::string& getFormatName();
    const std::string& getFormatName() const { return const_cast<PolicyFile*>(this)->getFormatName(); }


    virtual void load(Policy& policy) const;
    virtual void load(Policy& policy) {
        ((const PolicyFile*)this)->load(policy);  // delegate to const version
    }

    static const std::string EXT_PAF;  
    static const std::string EXT_XML;  

    static const boost::regex SPACE_RE;  
    static const boost::regex COMMENT;   

    static const boost::regex CONTENTID;

protected:
    boost::filesystem::path _file;

private:
    const std::string& cacheName(const std::string& name) {
        _format = name;
        return _format;
    }

    std::string _format;
    PolicyParserFactory::Ptr _pfact;

    // inherits SupportedFormats _formats from PolicySource
};

}  // namespace policy
}  // namespace pex
}  // namespace lsst

#endif  // LSST_PEX_POLICY_FILE_H