<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>RAUL: Configuration.hpp Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> </ul> </div> <div class="header"> <div class="headertitle"> <h1>Configuration.hpp</h1> </div> </div> <div class="contents"> <div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* This file is part of Raul.</span> <a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2009 David Robillard <http://drobilla.net></span> <a name="l00003"></a>00003 <span class="comment"> *</span> <a name="l00004"></a>00004 <span class="comment"> * Raul is free software; you can redistribute it and/or modify it under the</span> <a name="l00005"></a>00005 <span class="comment"> * terms of the GNU General Public License as published by the Free Software</span> <a name="l00006"></a>00006 <span class="comment"> * Foundation; either version 2 of the License, or (at your option) any later</span> <a name="l00007"></a>00007 <span class="comment"> * version.</span> <a name="l00008"></a>00008 <span class="comment"> *</span> <a name="l00009"></a>00009 <span class="comment"> * Raul is distributed in the hope that it will be useful, but WITHOUT ANY</span> <a name="l00010"></a>00010 <span class="comment"> * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span> <a name="l00011"></a>00011 <span class="comment"> * FOR A PARTICULAR PURPOSE. See the GNU General Public License for details.</span> <a name="l00012"></a>00012 <span class="comment"> *</span> <a name="l00013"></a>00013 <span class="comment"> * You should have received a copy of the GNU General Public License along</span> <a name="l00014"></a>00014 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span> <a name="l00015"></a>00015 <span class="comment"> * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</span> <a name="l00016"></a>00016 <span class="comment"> */</span> <a name="l00017"></a>00017 <a name="l00018"></a>00018 <span class="preprocessor">#ifndef RAUL_CONFIGURATION_HPP</span> <a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define RAUL_CONFIGURATION_HPP</span> <a name="l00020"></a>00020 <span class="preprocessor"></span> <a name="l00021"></a>00021 <span class="preprocessor">#include <map></span> <a name="l00022"></a>00022 <span class="preprocessor">#include <string></span> <a name="l00023"></a>00023 <span class="preprocessor">#include <list></span> <a name="l00024"></a>00024 <span class="preprocessor">#include <ostream></span> <a name="l00025"></a>00025 <span class="preprocessor">#include <exception></span> <a name="l00026"></a>00026 <span class="preprocessor">#include "raul/Atom.hpp"</span> <a name="l00027"></a>00027 <a name="l00028"></a>00028 <span class="keyword">namespace </span>Raul { <a name="l00029"></a>00029 <a name="l00034"></a><a class="code" href="classRaul_1_1Configuration.html">00034</a> <span class="keyword">class </span><a class="code" href="classRaul_1_1Configuration.html" title="Program configuration (command line options and/or configuration file).">Configuration</a> { <a name="l00035"></a>00035 <span class="keyword">public</span>: <a name="l00036"></a>00036 <a class="code" href="classRaul_1_1Configuration.html" title="Program configuration (command line options and/or configuration file).">Configuration</a>(<span class="keyword">const</span> std::string& shortdesc, <span class="keyword">const</span> std::string& desc) <a name="l00037"></a>00037 : _shortdesc(shortdesc) <a name="l00038"></a>00038 , _desc(desc) <a name="l00039"></a>00039 , _max_name_length(0) <a name="l00040"></a>00040 {} <a name="l00041"></a>00041 <a name="l00042"></a>00042 <a class="code" href="classRaul_1_1Configuration.html" title="Program configuration (command line options and/or configuration file).">Configuration</a>& <a class="code" href="classRaul_1_1Configuration.html#a9508a88d36f6a7ef2353f1a01b88942d" title="Add a configuration option.">add</a>( <a name="l00043"></a>00043 <span class="keyword">const</span> std::string& name, <a name="l00044"></a>00044 <span class="keywordtype">char</span> letter, <a name="l00045"></a>00045 <span class="keyword">const</span> std::string& desc, <a name="l00046"></a>00046 <span class="keyword">const</span> Atom::Type type, <a name="l00047"></a>00047 <span class="keyword">const</span> <a class="code" href="classRaul_1_1Atom.html" title="A piece of data with some type.">Atom</a>& value); <a name="l00048"></a>00048 <a name="l00049"></a>00049 <span class="keywordtype">void</span> print_usage(<span class="keyword">const</span> std::string& program, std::ostream& os); <a name="l00050"></a>00050 <a name="l00051"></a>00051 <span class="keyword">struct </span>CommandLineError : <span class="keyword">public</span> std::exception { <a name="l00052"></a>00052 CommandLineError(<span class="keyword">const</span> std::string& m) : msg(m) {} <a name="l00053"></a>00053 ~CommandLineError() <span class="keywordflow">throw</span>() {} <a name="l00054"></a>00054 <span class="keyword">const</span> <span class="keywordtype">char</span>* what() <span class="keyword">const</span> <span class="keywordflow">throw</span>() { <span class="keywordflow">return</span> msg.c_str(); } <a name="l00055"></a>00055 std::string msg; <a name="l00056"></a>00056 }; <a name="l00057"></a>00057 <a name="l00058"></a>00058 <span class="keywordtype">void</span> <a class="code" href="classRaul_1_1Configuration.html#a1cdb37986b2255de63d782b39f368d18" title="Parse command line arguments.">parse</a>(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** argv) <span class="keywordflow">throw</span> (CommandLineError); <a name="l00059"></a>00059 <a name="l00060"></a>00060 <span class="keywordtype">void</span> print(std::ostream& os, <span class="keyword">const</span> std::string mime_type=<span class="stringliteral">"text/plain"</span>) <span class="keyword">const</span>; <a name="l00061"></a>00061 <a name="l00062"></a>00062 <span class="keyword">const</span> <a class="code" href="classRaul_1_1Atom.html" title="A piece of data with some type.">Raul::Atom</a>& option(<span class="keyword">const</span> std::string& long_name); <a name="l00063"></a>00063 <a name="l00064"></a>00064 <span class="keyword">private</span>: <a name="l00065"></a>00065 <span class="keyword">struct </span>Option { <a name="l00066"></a>00066 <span class="keyword">public</span>: <a name="l00067"></a>00067 Option(<span class="keyword">const</span> std::string& n, <span class="keywordtype">char</span> l, <span class="keyword">const</span> std::string& d, <a name="l00068"></a>00068 <span class="keyword">const</span> Atom::Type type, <span class="keyword">const</span> <a class="code" href="classRaul_1_1Atom.html" title="A piece of data with some type.">Raul::Atom</a>& def) <a name="l00069"></a>00069 : name(n), letter(l), desc(d), type(type), default_value(def), value(def) <a name="l00070"></a>00070 {} <a name="l00071"></a>00071 <a name="l00072"></a>00072 std::string name; <a name="l00073"></a>00073 <span class="keywordtype">char</span> letter; <a name="l00074"></a>00074 std::string desc; <a name="l00075"></a>00075 Atom::Type type; <a name="l00076"></a>00076 <a class="code" href="classRaul_1_1Atom.html" title="A piece of data with some type.">Raul::Atom</a> default_value; <a name="l00077"></a>00077 <a class="code" href="classRaul_1_1Atom.html" title="A piece of data with some type.">Raul::Atom</a> value; <a name="l00078"></a>00078 }; <a name="l00079"></a>00079 <a name="l00080"></a>00080 <span class="keyword">struct </span>OptionNameOrder { <a name="l00081"></a>00081 <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator()(<span class="keyword">const</span> Option& a, <span class="keyword">const</span> Option& b) { <a name="l00082"></a>00082 <span class="keywordflow">return</span> a.name < b.name; <a name="l00083"></a>00083 } <a name="l00084"></a>00084 }; <a name="l00085"></a>00085 <a name="l00086"></a>00086 <span class="keyword">typedef</span> std::map<std::string, Option> Options; <a name="l00087"></a>00087 <span class="keyword">typedef</span> std::map<char, std::string> ShortNames; <a name="l00088"></a>00088 <span class="keyword">typedef</span> std::list<std::string> Files; <a name="l00089"></a>00089 <a name="l00090"></a>00090 <span class="keywordtype">int</span> set_value_from_string(Configuration::Option& option, <span class="keyword">const</span> std::string& value) <a name="l00091"></a>00091 <span class="keywordflow">throw</span> (Configuration::CommandLineError); <a name="l00092"></a>00092 <a name="l00093"></a>00093 <span class="keyword">const</span> std::string _shortdesc; <a name="l00094"></a>00094 <span class="keyword">const</span> std::string _desc; <a name="l00095"></a>00095 Options _options; <a name="l00096"></a>00096 ShortNames _short_names; <a name="l00097"></a>00097 Files _files; <a name="l00098"></a>00098 <span class="keywordtype">size_t</span> _max_name_length; <a name="l00099"></a>00099 }; <a name="l00100"></a>00100 <a name="l00101"></a>00101 } <span class="comment">// namespace Raul</span> <a name="l00102"></a>00102 <a name="l00103"></a>00103 <span class="preprocessor">#endif // RAUL_CONFIGURATION_HPP</span> <a name="l00104"></a>00104 <span class="preprocessor"></span> </pre></div></div> </div> <hr class="footer"/><address class="footer"><small>Generated on Wed Oct 6 2010 for RAUL by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address> </body> </html>