src/third_party/libjingle/source/talk/base/optionsfile.h

   1 /*
   2  * libjingle
   3  * Copyright 2008, Google Inc.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  *  1. Redistributions of source code must retain the above copyright notice,
   9  *     this list of conditions and the following disclaimer.
  10  *  2. Redistributions in binary form must reproduce the above copyright notice,
  11  *     this list of conditions and the following disclaimer in the documentation
  12  *     and/or other materials provided with the distribution.
  13  *  3. The name of the author may not be used to endorse or promote products
  14  *     derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
  19  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef TALK_BASE_OPTIONSFILE_H_
  29 #define TALK_BASE_OPTIONSFILE_H_
  30
  31 #include <map>
  32 #include <string>
  33
  34 namespace talk_base {
  35
  36 // Implements storage of simple options in a text file on disk. This is
  37 // cross-platform, but it is intended mostly for Linux where there is no
  38 // first-class options storage system.
  39 class OptionsFile {
  40  public:
  41   OptionsFile(const std::string &path);
  42
  43   // Loads the file from disk, overwriting the in-memory values.
  44   bool Load();
  45   // Saves the contents in memory, overwriting the on-disk values.
  46   bool Save();
  47
  48   bool GetStringValue(const std::string& option, std::string* out_val) const;
  49   bool GetIntValue(const std::string& option, int* out_val) const;
  50   bool SetStringValue(const std::string& option, const std::string& val);
  51   bool SetIntValue(const std::string& option, int val);
  52   bool RemoveValue(const std::string& option);
  53
  54  private:
  55   typedef std::map<std::string, std::string> OptionsMap;
  56
  57   static bool IsLegalName(const std::string &name);
  58   static bool IsLegalValue(const std::string &value);
  59
  60   std::string path_;
  61   OptionsMap options_;
  62 };
  63
  64 }  // namespace talk_base
  65
  66 #endif  // TALK_BASE_OPTIONSFILE_H_