src/util/ege-tags.h

   1 #ifndef SEEN_EGE_TAGS_H
   2 #define SEEN_EGE_TAGS_H
   3
   4 /* ***** BEGIN LICENSE BLOCK *****
   5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   6  *
   7  * The contents of this file are subject to the Mozilla Public License Version
   8  * 1.1 (the "License"); you may not use this file except in compliance with
   9  * the License. You may obtain a copy of the License at
  10  * http://www.mozilla.org/MPL/
  11  *
  12  * Software distributed under the License is distributed on an "AS IS" basis,
  13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  14  * for the specific language governing rights and limitations under the
  15  * License.
  16  *
  17  * The Original Code is EGE Tagging Support.
  18  *
  19  * The Initial Developer of the Original Code is
  20  * Jon A. Cruz.
  21  * Portions created by the Initial Developer are Copyright (C) 2009
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include <string>
  41 #include <vector>
  42 #include <map>
  43
  44 /*
  45  * Implements base tagging of http://create.freedesktop.org/wiki/ResourceTagging .
  46  */
  47
  48 // Note that this API is preliminary and subject to frequent change:
  49
  50 namespace ege
  51 {
  52
  53 class Label
  54 {
  55 public:
  56     Label();
  57     Label(std::string const& lang, std::string const& value);
  58     ~Label();
  59
  60     std::string lang;
  61     std::string value;
  62 };
  63
  64 class Tag
  65 {
  66 public:
  67     Tag();
  68     Tag(std::string const& key);
  69     ~Tag();
  70
  71     std::string key;
  72     std::vector<Label> labels;
  73 };
  74
  75
  76 /**
  77  * Contains a set of tags with unique keys, and with locale support.
  78  *
  79  */
  80 class TagSet
  81 {
  82 public:
  83     TagSet();
  84     ~TagSet();
  85
  86     std::string const & getLang() const;
  87     void setLang(std::string const& lang);
  88
  89     /**
  90      * Adds or updates a tag.
  91      *
  92      * @return true if a tag was updated, false if it was added.
  93      */
  94     bool addTag(Tag const& tag);
  95     std::vector<Tag> const& getTags();
  96
  97     int getCount( std::string const& key );
  98     void increment( std::string const& key );
  99     void decrement( std::string const& key );
 100
 101 private:
 102
 103     std::string lang;
 104     std::vector<Tag> tags;
 105     std::map<std::string, int> counts;
 106 };
 107
 108 } // namespace ege
 109
 110
 111 #endif // SEEN_EGE_TAGS_H
 112 /*
 113   Local Variables:
 114   mode:c++
 115   c-file-style:"stroustrup"
 116   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 117   indent-tabs-mode:nil
 118   fill-column:99
 119   End:
 120 */
 121 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :