vocabulary.h

Go to the documentation of this file.

#ifndef EPT_DEBTAGS_VOCABULARY_H
#define EPT_DEBTAGS_VOCABULARY_H

/*
 * Copyright (C) 2003,2004,2005,2006,2007  Enrico Zini <enrico@debian.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 2 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 GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#include <string>
#include <vector>
#include <set>
#include <map>
#include <cstdio>
#include <iosfwd>

namespace ept {
namespace debtags {
namespace voc {

std::string getfacet(const std::string& tagname);

struct Data : public std::map<std::string, std::string>
{
protected:
    // Cache the parsed short description
    mutable std::string m_desc;

public:
    std::string name;

    std::string shortDescription() const;

    std::string longDescription() const;
};

struct TagData : public Data
{
    TagData() {}

    // Facet facet() const;
};

class FacetData : public Data
{
public:
    std::map<std::string, TagData> m_tags;

    FacetData() {}

    TagData& obtainTag(const std::string& fullname);

    bool hasTag(const std::string& name) const;

    const TagData* tagData(const std::string& name) const;

    std::set<std::string> tags() const;
};

}

class Vocabulary
{
protected:
    std::map<std::string, voc::FacetData> m_facets;

    time_t m_timestamp;

    // Empty parsed data to return when data is asked for IDs == -1
    std::map<std::string, std::string> emptyData;

    void parseVocBuf(std::map<std::string, std::string>& res, size_t ofs, size_t len) const;

    voc::FacetData& obtainFacet(const std::string& name);
    voc::TagData& obtainTag(const std::string& fullname);

    void write(std::ostream& out);

public:
    Vocabulary(bool empty=false);
    ~Vocabulary();

    time_t timestamp() const { return m_timestamp; }

    bool hasData() const { return m_timestamp != 0; }

    bool empty() const { return m_facets.empty(); }

    bool hasFacet(const std::string& name) const;

    bool hasTag(const std::string& name) const;

    const voc::FacetData* facetData(const std::string& name) const;

    const voc::TagData* tagData(const std::string& fullname) const;

    std::set<std::string> facets() const;

    std::set<std::string> tags() const;

    std::set<std::string> tags(const std::string& facet) const;

#if 0
    const DerivedTagList& getEquations() const throw () { return equations; }
    
    FacetSet facets(const FacetMatcher& filter) const throw () { return getFiltered(filter); }
#endif

    void load(const std::string& pathname);

    void read(FILE* input, const std::string& pathname);

    void write();

    void write(const std::string& fname);

    static std::string pathname();
};

}
}

// vim:set ts=4 sw=4:
#endif