diff options
| author | Ossama Othman <ossama.othman@intel.com> | 2013-10-03 13:35:02 -0700 |
|---|---|---|
| committer | Ossama Othman <ossama.othman@intel.com> | 2013-10-03 14:10:29 -0700 |
| commit | 9481ce3c822a1c9734068f8902e79547afc0d38b (patch) | |
| tree | 096aa0fc6eba1c8449281385476f795924d94802 | |
| parent | 38bb9a71ff04daff8702f20fed901831b690e29b (diff) | |
| download | settings-daemon-9481ce3c822a1c9734068f8902e79547afc0d38b.tar.gz settings-daemon-9481ce3c822a1c9734068f8902e79547afc0d38b.tar.bz2 settings-daemon-9481ce3c822a1c9734068f8902e79547afc0d38b.zip | |
TIVI-1924: Initial commit of IVI settings daemon.submit/tizen_ivi_release/20131120.032742submit/tizen_ivi_milestone/20131113.054518submit/tizen_ivi_genivi/20140131.070647submit/tizen_ivi_generic/20140131.065503submit/tizen/20131003.211152ivi_oct_m2accepted/tizen_ivi_release/20131120.050012accepted/tizen/ivi/genivi/20140131.070902accepted/tizen/20131003.220350accepted/tizen/20131003.215933tizen_ivi_genivi
This daemon provides a native backend to the Settings app.
It fills functionality gaps in the Web API, such as WiFi and
date/time, required by the Settings app.
This version contains support for unsecured WiFi connections
and setting the date and time.
Change-Id: I2810d0910029c4ed146e9ff740c246d428767649
Signed-off-by: Ossama Othman <ossama.othman@intel.com>
77 files changed, 10041 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6d23065 --- /dev/null +++ b/.gitignore @@ -0,0 +1,36 @@ +*.o +*.lo +*.la +*.so* +*.a +*~ +*#*# +config.log +config.status +Makefile +Makefile.in +.deps +INSTALL +missing +aclocal.m4 +ar-lib +autom4te.cache/ +compile +configure +depcomp +install-sh +libtool +ltmain.sh +.libs +stamp* +etc/settingsd.conf +src/settingsd +tests/settings_test +config.* +!src/config.h +!packaging/settingsd.socket +*.tar.* +docs +*-glue.[hc] +core* + @@ -0,0 +1 @@ +Ossama Othman @@ -0,0 +1,5 @@ + Tizen IVI Settings Daemon + ========================= + +The Tizen IVI Settings daemon is licensed under LGPL v2.1. See the +`COPYING.LESSER' file for the actual LGPL v2.1 license terms. diff --git a/COPYING.LESSER b/COPYING.LESSER new file mode 100644 index 0000000..4362b49 --- /dev/null +++ b/COPYING.LESSER @@ -0,0 +1,502 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + <one line to give the library's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + <signature of Ty Coon>, 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..15cadff --- /dev/null +++ b/Doxyfile @@ -0,0 +1,1749 @@ +# Doxyfile 1.7.4 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = settingsd + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Tizen Settings Daemon" + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = docs + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful if your file system +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this +# tag. The format is ext=language, where ext is a file extension, and language +# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, +# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions +# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also makes the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penalty. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will roughly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols + +SYMBOL_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespaces are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or macro consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and macros in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command <command> <input-file>, where <command> is the value of +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. The create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. +# You can optionally specify a file name after the option, if omitted +# DoxygenLayout.xml will be used as the name of the layout file. + +LAYOUT_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# The WARN_NO_PARAMDOC option can be enabled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = include/settingsd lib plugins src tests settingsd.dox + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.d \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.idl \ + *.odl \ + *.cs \ + *.php \ + *.php3 \ + *.inc \ + *.m \ + *.mm \ + *.dox \ + *.py \ + *.f90 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = *-glue.[hc] + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command <filter> <input-file>, where <filter> +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty or if +# non of the patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = YES + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is adviced to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the stylesheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = YES + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> +# Qt Help Project / Custom Filters</a>. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> +# Qt Help Project / Filter Attributes</a>. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 4 + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. + +GENERATE_TREEVIEW = NO + +# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list. + +USE_INLINE_TREES = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the +# mathjax.org site, so you can quickly see the result without installing +# MathJax, but it is strongly recommended to install a local copy of MathJax +# before deployment. + +MATHJAX_RELPATH = http://www.mathjax.org/mathjax + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvantages are that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! + +LATEX_FOOTER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition that +# overrules the definition found in the source code. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = YES + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will write a font called Helvetica to the output +# directory and reference it in all dot files that doxygen generates. +# When you want a differently looking font you can specify the font name +# using DOT_FONTNAME. You need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# containing the font. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..aaf88b2 --- /dev/null +++ b/Makefile.am @@ -0,0 +1,40 @@ +## Copyright 2012, 2013 Intel Corporation All Rights Reserved. +## +## This library is free software; you can redistribute it and/or +## modify it under the terms of the GNU Lesser General Public +## License as published by the Free Software Foundation; +## version 2.1 of the License. +## +## This library 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 +## Lesser General Public License for more details. +## +## You should have received a copy of the GNU Lesser General Public +## License along with this library; if not, write to the Free Software +## Foundation, Inc., 51 Franklin Street, Fifth Floor, +## Boston, MA 02110-1301 USA + +SUBDIRS = doc etc include lib plugins src tests + +EXTRA_DIST = COPYING.LESSER Doxyfile settingsd.dox settingsd.org + +ACLOCAL_AMFLAGS = -I m4 + +# Doxygen stuff +#include $(top_srcdir)/aminclude.am +MOSTLYCLEANFILES = $(DX_CLEANFILES) + +# Copyright Year Consistency Check +# +# This check assumes that all copyright statements have the same years +# listed. +distcheck-hook: + @test `$(GREP) --recursive --binary-files=without-match Copyright.*Intel * \ + | sed -e 's/^.*Copyright \(([Cc]).\)*\(.*\).* Intel.*$$/\2/g' \ + -e 's/,$$//g' | sort -u | wc -l` -ne 1 \ + || (echo ======================================================; \ + echo DIST ERROR: Copyright years in files are inconsistent!; \ + echo ======================================================; \ + exit 1) + @@ -0,0 +1,2 @@ + Tizen Settings Daemon + ===================== @@ -0,0 +1 @@ +See the file `settingsd.org' for TODO list items. diff --git a/aminclude.am b/aminclude.am new file mode 100644 index 0000000..f4299e0 --- /dev/null +++ b/aminclude.am @@ -0,0 +1,183 @@ +# Copyright (C) 2004 Oren Ben-Kiki +# This file is distributed under the same terms as the Automake macro files. + +# Generate automatic documentation using Doxygen. Goals and variables values +# are controlled by the various DX_COND_??? conditionals set by autoconf. +# +# The provided goals are: +# doc: Generate all doxygen documentation. +# doxygen-run: Run doxygen, which will generate some of the documentation +# (HTML, CHM, CHI, MAN, RTF, XML) but will not do the post +# processing required for the rest of it (PS, PDF, and some MAN). +# doxygen-man: Rename some doxygen generated man pages. +# doxygen-ps: Generate doxygen PostScript documentation. +# doxygen-pdf: Generate doxygen PDF documentation. +# +# Note that by default these are not integrated into the automake goals. If +# doxygen is used to generate man pages, you can achieve this integration by +# setting man3_MANS to the list of man pages generated and then adding the +# dependency: +# +# $(man3_MANS): doc +# +# This will cause make to run doxygen and generate all the documentation. +# +# The following variable is intended for use in Makefile.am: +# +# DX_CLEANFILES = everything to clean. +# +# This is usually added to MOSTLYCLEANFILES. + +## --------------------------------- ## +## Format-independent Doxygen rules. ## +## --------------------------------- ## + +if DX_COND_doc + +## ------------------------------- ## +## Rules specific for HTML output. ## +## ------------------------------- ## + +if DX_COND_html + +DX_CLEAN_HTML = @DX_DOCDIR@/html + +endif DX_COND_html + +## ------------------------------ ## +## Rules specific for CHM output. ## +## ------------------------------ ## + +if DX_COND_chm + +DX_CLEAN_CHM = @DX_DOCDIR@/chm + +if DX_COND_chi + +DX_CLEAN_CHI = @DX_DOCDIR@/@PACKAGE@.chi + +endif DX_COND_chi + +endif DX_COND_chm + +## ------------------------------ ## +## Rules specific for MAN output. ## +## ------------------------------ ## + +if DX_COND_man + +DX_CLEAN_MAN = @DX_DOCDIR@/man +DX_MANS = $(DX_CLEAN_MAN)/man3 +man3_MANS = $(DX_MANS)/control.h.3 $(DX_MANS)/conversions.h.3 \ + $(DX_MANS)/register.h.3 $(DX_MANS)/utils.h.3 +$(man3_MANS): doc + +endif DX_COND_man + +## ------------------------------ ## +## Rules specific for RTF output. ## +## ------------------------------ ## + +if DX_COND_rtf + +DX_CLEAN_RTF = @DX_DOCDIR@/rtf + +endif DX_COND_rtf + +## ------------------------------ ## +## Rules specific for XML output. ## +## ------------------------------ ## + +if DX_COND_xml + +DX_CLEAN_XML = @DX_DOCDIR@/xml + +endif DX_COND_xml + +## ----------------------------- ## +## Rules specific for PS output. ## +## ----------------------------- ## + +if DX_COND_ps + +DX_CLEAN_PS = @DX_DOCDIR@/@PACKAGE@.ps + +DX_PS_GOAL = doxygen-ps + +doxygen-ps: @DX_DOCDIR@/@PACKAGE@.ps + +@DX_DOCDIR@/@PACKAGE@.ps: @DX_DOCDIR@/@PACKAGE@.tag + cd @DX_DOCDIR@/latex; \ + rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \ + $(DX_LATEX) refman.tex; \ + $(MAKEINDEX_PATH) refman.idx; \ + $(DX_LATEX) refman.tex; \ + countdown=5; \ + while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \ + refman.log > /dev/null 2>&1 \ + && test $$countdown -gt 0; do \ + $(DX_LATEX) refman.tex; \ + countdown=`expr $$countdown - 1`; \ + done; \ + $(DX_DVIPS) -o ../@PACKAGE@.ps refman.dvi + +endif DX_COND_ps + +## ------------------------------ ## +## Rules specific for PDF output. ## +## ------------------------------ ## + +if DX_COND_pdf + +DX_CLEAN_PDF = @DX_DOCDIR@/@PACKAGE@.pdf + +DX_PDF_GOAL = doxygen-pdf + +doxygen-pdf: @DX_DOCDIR@/@PACKAGE@.pdf + +@DX_DOCDIR@/@PACKAGE@.pdf: @DX_DOCDIR@/@PACKAGE@.tag + cd @DX_DOCDIR@/latex; \ + rm -f *.aux *.toc *.idx *.ind *.ilg *.log *.out; \ + $(DX_PDFLATEX) refman.tex; \ + $(DX_MAKEINDEX) refman.idx; \ + $(DX_PDFLATEX) refman.tex; \ + countdown=5; \ + while $(DX_EGREP) 'Rerun (LaTeX|to get cross-references right)' \ + refman.log > /dev/null 2>&1 \ + && test $$countdown -gt 0; do \ + $(DX_PDFLATEX) refman.tex; \ + countdown=`expr $$countdown - 1`; \ + done; \ + mv refman.pdf ../@PACKAGE@.pdf + +endif DX_COND_pdf + +## ------------------------------------------------- ## +## Rules specific for LaTeX (shared for PS and PDF). ## +## ------------------------------------------------- ## + +if DX_COND_latex + +DX_CLEAN_LATEX = @DX_DOCDIR@/latex + +endif DX_COND_latex + +.PHONY: doxygen-run doc $(DX_PS_GOAL) $(DX_PDF_GOAL) + +.INTERMEDIATE: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL) + +doxygen-run: @DX_DOCDIR@/@PACKAGE@.tag + +doc: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL) + +@DX_DOCDIR@/@PACKAGE@.tag: $(DX_CONFIG) $(pkginclude_HEADERS) + rm -rf @DX_DOCDIR@ + $(DX_ENV) $(DX_DOXYGEN) $(srcdir)/$(DX_CONFIG) + +DX_CLEANFILES = \ + @DX_DOCDIR@/@PACKAGE@.tag \ + -r $(DX_CLEAN_HTML) $(DX_CLEAN_CHM) $(DX_CLEAN_CHI) $(DX_CLEAN_MAN) \ + $(DX_CLEAN_RTF) $(DX_CLEAN_XML) $(DX_CLEAN_PS) $(DX_CLEAN_PDF) \ + $(DX_CLEAN_LATEX) $(DX_DOCDIR) + +endif DX_COND_doc diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..326ec34 --- /dev/null +++ b/configure.ac @@ -0,0 +1,197 @@ +# -*- Autoconf -*- +# Process this file with autoconf to produce a configure script. + +AC_PREREQ([2.68]) + +#todo Update with appropriate license after open-source approval. +AC_COPYRIGHT([ +Copyright 2012, 2013 Intel Corporation All Rights Reserved. + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; +version 2.1 of the License. + +This library 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 +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, +Boston, MA 02110-1301 USA +]) + +AC_INIT([settingsd], [0.1], [ossama.othman@intel.com]) +AM_INIT_AUTOMAKE([1.11.1 foreign -Wall -Werror silent-rules]) +LT_INIT([disable-static dlopen]) + +AC_CONFIG_SRCDIR([src/daemon.cpp]) +AC_CONFIG_HEADERS([lib/config.hpp]) + +AC_CONFIG_MACRO_DIR([m4]) + +AH_TOP([ +/** + * @file config.hpp + * + * @brief Tizen IVI Settings Daemon configuration header. + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ +]) + +# Checks for programs. +AC_PROG_CXX +AC_PROG_CC +AM_PROG_CC_C_O +AM_PROG_AR + +# Check for Doxygen +#DX_DOXYGEN_FEATURE(ON) +#DX_DOT_FEATURE(ON) +#DX_HTML_FEATURE(ON) +#DX_CHM_FEATURE(OFF) +#DX_CHI_FEATURE(OFF) +#DX_MAN_FEATURE(OFF) +#DX_RTF_FEATURE(OFF) +#DX_XML_FEATURE(OFF) +#DX_PDF_FEATURE(OFF) +#DX_PS_FEATURE(OFF) +#DX_INIT_DOXYGEN([settingsd], [Doxyfile], [docs]) + +# Enable pkg-config +PKG_PROG_PKG_CONFIG + +# Checks for libraries. +# Check for Boost libraries used by settingsd. +AX_BOOST_BASE([1.51.0]) +AX_BOOST_FILESYSTEM +AX_BOOST_PROGRAM_OPTIONS + +PKG_CHECK_MODULES([GIO], [gio-unix-2.0]) +AC_SUBST([GIO_LIBS]) +AC_SUBST([GIO_CFLAGS]) + +PKG_CHECK_MODULES([JSON_GLIB], [json-glib-1.0]) +AC_SUBST([JSON_GLIB_LIBS]) +AC_SUBST([JSON_GLIB_CFLAGS]) + +PKG_CHECK_MODULES([LIBWEBSOCKETS], [libwebsockets]) +AC_SUBST([LIBWEBSOCKETS_LIBS]) +AC_SUBST([LIBWEBSOCKETS_CFLAGS]) + +# Checks for header files. + +# Checks for typedefs, structures, and compiler characteristics. +# Check for C++11 support. (macro from autoconf-archive package) +AX_CXX_COMPILE_STDCXX_0X +AS_IF([test "x$ax_cv_cxx_compile_cxx0x_cxx" = "xyes"], + [CXXFLAGS="-std=c++0x $CXXFLAGS"], + [AS_IF([test "x$ax_cv_cxx_compile_cxx0x_gxx" = "xyes"], + [CXXFLAGS="-std=gnu++0x $CXXFLAGS"], + [AC_MSG_FAILURE([Required C++11 support is not available.]) + ]) + ]) + +# Enable gcc symbol visibility support. +AC_LANG_PUSH([C++]) +AC_CACHE_CHECK([for g++ symbol visibility support], + [settingsd_cv_prog_gcc_symbol_visibility], + [ + AC_COMPILE_IFELSE([ + AC_LANG_SOURCE([ +#define FOO_EXPORT __attribute__ ((visibility ("default"))) +#define FOO_LOCAL __attribute__ ((visibility ("hidden"))) + +class FOO_EXPORT foo +{ +public: + foo() : x(0) {} + int baz() { return bar(); } +private: + FOO_LOCAL int bar() { x += 10; return x; } +private: + int x; +}; + +extern "C" FOO_EXPORT int snafu() { foo tmp; return tmp.baz(); } + ]) + ], + [settingsd_cv_prog_gcc_symbol_visibility=yes], + [settingsd_cv_prog_gcc_symbol_visibility=no]) +]) +AC_LANG_POP([C++]) + +AM_CONDITIONAL([SETTINGS_USE_GCC_SYMBOL_VISIBILITY], + [test "x$settingsd_cv_prog_gcc_symbol_visibility" = "xyes"]) + + +# Checks for library functions. + +# Rather than check dlopen() again, just leverage values cached during +# LT_INIT(). This isn't a bit brittle since the cache variable name +# could potentially change. +AC_SUBST([IVI_SETTINGS_DLOPEN_LIBS],[$lt_cv_dlopen_libs]) + +# Do not use old Boost.filesystem features and functions. +AC_DEFINE([BOOST_FILESYSTEM_NO_DEPRECATED], + [], + [Do not use old Boost.filesystem features and functions.]) + +# IVI settingsd D-Bus name +IVI_SETTINGS_DBUS_NAME="org.tizen.$PACKAGE" +AC_SUBST([IVI_SETTINGS_DBUS_NAME],[$IVI_SETTINGS_DBUS_NAME]) +AC_DEFINE_UNQUOTED([IVI_SETTINGS_DBUS_NAME], + ["$IVI_SETTINGS_DBUS_NAME"], + [The IVI settingsd D-Bus name.]) + +# Default IVI settingsd web socket server port +IVI_SETTINGS_DEFAULT_WEBSOCKET_PORT=16000 +AC_SUBST([websocketport], + [$IVI_SETTINGS_DEFAULT_WEBSOCKET_PORT]) +AC_DEFINE_UNQUOTED([IVI_SETTINGS_DEFAULT_WEBSOCKET_PORT], + [$IVI_SETTINGS_DEFAULT_WEBSOCKET_PORT], + [The default TCP/IP port on which the web socket + server should listen.]) + +# Enable C++ compiler warnings if we're using gcc. We do this after +# all autoconf tests have been run since not all autoconf macros are +# warning free. +IVI_SETTINGS_WARNING_FLAGS="-Wextra -Wall -Werror -Wformat=2 -pedantic" +AS_IF([test "x$GCC" = "xyes"], + [CXXFLAGS="$IVI_SETTINGS_WARNING_FLAGS $CXXFLAGS"], + []) + +# Specify which files are to be generated by the `configure' script. +AC_CONFIG_FILES([ + Makefile + doc/Makefile + etc/Makefile + include/Makefile + include/settingsd/Makefile + lib/Makefile + plugins/Makefile + plugins/connman/Makefile + src/Makefile + tests/Makefile +]) + +AC_OUTPUT diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..51b7259 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,18 @@ +## Copyright 2013 Intel Corporation All Rights Reserved. +## +## This library is free software; you can redistribute it and/or +## modify it under the terms of the GNU Lesser General Public +## License as published by the Free Software Foundation; +## version 2.1 of the License. +## +## This library 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 +## Lesser General Public License for more details. +## +## You should have received a copy of the GNU Lesser General Public +## License along with this library; if not, write to the Free Software +## Foundation, Inc., 51 Franklin Street, Fifth Floor, +## Boston, MA 02110-1301 USA + +EXTRA_DIST = settings-protocol.js diff --git a/doc/settings-protocol.js b/doc/settings-protocol.js new file mode 100644 index 0000000..6fd0ea7 --- /dev/null +++ b/doc/settings-protocol.js @@ -0,0 +1,315 @@ +// -------------------------------------------------------------- +// Overview +// -------------------------------------------------------------- +// General form of a request +var request = + { + "type": request_type + "transactionid": request_transaction_id + "name": request_name + "value": request_args + } + +// Response for successful operation +var response = + { + "type": request_type + "transactionid": request_transaction_id + "result": "succeeded" + ... + <setting specific results> + ... + } + +// Response for failed operation +var response = + { + "type": request_type, + "transactionid": request_transaction_id, + "result": "failed" + "reason": "<some error message>" + } + +// -------------------------------------------------------------- +// Bluetooth +// -------------------------------------------------------------- +// Check if bluetooth subsystem is enabled/powered. +var request = + { + "type": "bluetooth", + "transactionid": "<some UUID>", + "name": "is_enabled", + "value": null + } + +// Enable bluetooth subsystem +var request = + { + "type": "bluetooth", + "transactionid": "<some UUID>", + "name": "enable", + "value": true + } + +// Disable bluetooth subsystem +var request = + { + "type": "bluetooth", + "transactionid": "<some UUID>", + "name": "enable", + "value": false + } + +// Successful is_enabled +var response = + { + "type": "bluetooth", + "transactionid": "<some UUID>", + "result": true or false + } + +// Successful enable/disable +var response = + { + "type": "bluetooth", + "transactionid": "<some UUID>", + "result": "succeeded" + } + +// -------------------------------------------------------------- +// WiFi +// -------------------------------------------------------------- +// Check if WiFi subsystem is enabled/powered. +var request = + { + "type": "wifi", + "transactionid": "<some UUID>", + "name": "is_enabled", + "value": null + } + +// Enable WiFi subsystem +var request = + { + "type": "wifi", + "transactionid": "<some UUID>", + "name": "enable", + "value": true + } + +// Disable WiFi subsystem +var request = + { + "type": "wifi", + "transactionid": "<some UUID>", + "name": "enable", + "value": false + } + +// Scan WiFi subsystem +var request = + { + "type": "wifi", + "transactionid": "<some UUID>", + "name": "scan", + "value": null + } + +// Connect to WiFi access point +var request = + { + "type": "wifi", + "transactionid": "<some UUID>", + "name": "connect", + "value": "<Connman service object path>" + } + +// Disconnect from WiFi access point +var request = + { + "type": "wifi", + "transactionid": "<some UUID>", + "name": "disconnect", + "value": "<Connman service object path>" + } + +// Successful is_enabled +var response = + { + "type": "wifi", + "transactionid": "<some UUID>", + "result": true or false + } + +// Successful enable/disable/connect/disconnect +var response = + { + "type": "wifi", + "transactionid": "<some UUID>", + "result": "succeeded" + } + +// Successful scan +var response = + { + "type": "wifi", + "transactionid": "3b5c9ebe-23fa-6b58-3f50-1203d7641441", + "result": "succeeded", + "value": [ + [ + [ + "/net/connman/service/ethernet_0010f32f5a70_cable", + { + "AutoConnect": true, + "Domains": [ + "ftrdhcpuser.net" + ], + "Domains.Configuration": [], + "Ethernet": { + "Address": "10:20:F3:2F:5E:23", + "Interface": "eno1", + "MTU": 1500, + "Method": "auto" + }, + "Favorite": true, + "IPv4": { + "Address": "192.168.1.20", + "Gateway": "192.168.1.1", + "Method": "dhcp", + "Netmask": "255.255.255.0" + }, + "IPv4.Configuration": { + "Method": "dhcp" + }, + "IPv6": {}, + "IPv6.Configuration": { + "Method": "auto", + "Privacy": "disabled" + }, + "Immutable": false, + "Name": "Wired", + "Nameservers": [ + "192.168.1.1", + "184.11.12.13" + ], + "Nameservers.Configuration": [], + "Provider": {}, + "Proxy": { + "Method": "direct" + }, + "Proxy.Configuration": {}, + "Security": [], + "State": "online", + "Timeservers": [ + "192.168.1.1", + "pool.ntp.org" + ], + "Timeservers.Configuration": [], + "Type": "ethernet" + } + ], + [ + "/net/connman/service/wifi_c8f733acdf96_3558364737_managed_psk", + { + "AutoConnect": false, + "BSSID": "42:18:23:98:93:f9", + "Domains": [], + "Domains.Configuration": [], + "EncryptionMode": "aes", + "Ethernet": { + "Address": "D8:A7:47:AC:66:10", + "Interface": "wlp1s0", + "MTU": 1500, + "Method": "auto" + }, + "Favorite": false, + "Frequency": 2412, + "IPv4": {}, + "IPv4.Configuration": { + "Method": "dhcp" + }, + "IPv6": {}, + "IPv6.Configuration": { + "Method": "auto", + "Privacy": "disabled" + }, + "Immutable": false, + "MaxRate": 54000000, + "Name": "TIZENIVI", + "Nameservers": [], + "Nameservers.Configuration": [], + "Provider": {}, + "Proxy": {}, + "Proxy.Configuration": {}, + "Security": [ + "psk", + "wps" + ], + "State": "idle", + "Strength": 78, + "Timeservers": [], + "Timeservers.Configuration": [], + "Type": "wifi" + } + ] + ] + ] + } + +// -------------------------------------------------------------- +// Clock +// -------------------------------------------------------------- +// Set time +var request = + { + "type": "clock", + "transactionid": "<some UUID>", + "name": "time", + "value": <time in seconds from Epoch> + } + +// Set timezone +var request = + { + "type": "clock", + "transactionid": "<some UUID>", + "name": "timezone", + "value": "<timezone typically found in tzdata>" + } + +// Set time/timezone updates +// NOTE: The "time" request will fail with a permission denied error +// if the value is set to "auto". +var request = + { + "type": "clock", + "transactionid": "<some UUID>", + "name": "time_updates" or "timezone_updates" + "value": "manual" or "auto" + } + +// Check if time/timezone updates are set to automatic +var request = + { + "type": "clock", + "transactionid": "<some UUID>", + "name": "is_time_updates_auto" or "is_timezone_updates_auto" + "value": null + } + +// Successful time/time_updates/timezone/timezone_updates +var response = + { + "type": "clock", + "transactionid": "<some UUID>", + "result": "succeeded" + } + +// Successful is_{time,timezone}_update_auto +var response = + { + "type": "clock", + "transactionid": "<some UUID>", + "result": "succeeded" + "value": true or false + } diff --git a/etc/Makefile.am b/etc/Makefile.am new file mode 100644 index 0000000..eb7c2ef --- /dev/null +++ b/etc/Makefile.am @@ -0,0 +1,41 @@ +## Copyright 2012, 2013 Intel Corporation All Rights Reserved. +## +## This library is free software; you can redistribute it and/or +## modify it under the terms of the GNU Lesser General Public +## License as published by the Free Software Foundation; +## version 2.1 of the License. +## +## This library 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 +## Lesser General Public License for more details. +## +## You should have received a copy of the GNU Lesser General Public +## License along with this library; if not, write to the Free Software +## Foundation, Inc., 51 Franklin Street, Fifth Floor, +## Boston, MA 02110-1301 USA + +EXTRA_DIST = settingsd.conf.in + +pkgsysconf_DATA = settingsd.conf +pkgsysconfdir = $(sysconfdir)/@PACKAGE@ + +## Silent mode output for settingsd config file generation. +config_verbose = $(config_verbose_$(V)) +config_verbose_ = $(config_verbose_$(AM_DEFAULT_VERBOSITY)) +config_verbose_0 = @echo CONFGEN $@; + +## The configure script won't fully expand $libdir so leverage `make' +## based variable expansion instead. +settingsd.conf: Makefile settingsd.conf.in + $(config_verbose)rm -f $@ $@.tmp; \ + srcdir=''; \ + test -f ./$@.in || srcdir=$(srcdir)/; \ + sed \ + -e 's,@pkglibdir[@],$(pkglibdir),g' \ + -e 's,@websocketport[@],$(websocketport),g' \ + $${srcdir}$@.in >$@.tmp; \ + chmod 644 $@.tmp; \ + mv $@.tmp $@ + +CLEANFILES = settingsd.conf diff --git a/etc/settingsd.conf.in b/etc/settingsd.conf.in new file mode 100644 index 0000000..fba7a84 --- /dev/null +++ b/etc/settingsd.conf.in @@ -0,0 +1,9 @@ +# ------------------------------------------------------------------ +# settingsd Configuration File +# ------------------------------------------------------------------ + +# settingsd plugin directory. +settings-dir = @pkglibdir@ + +# The TCP/IP port on which the web socket server should listen. +websocket-port = @websocketport@ diff --git a/include/Makefile.am b/include/Makefile.am new file mode 100644 index 0000000..4d8ee6f --- /dev/null +++ b/include/Makefile.am @@ -0,0 +1,18 @@ +## Copyright 2013 Intel Corporation All Rights Reserved. +## +## This library is free software; you can redistribute it and/or +## modify it under the terms of the GNU Lesser General Public +## License as published by the Free Software Foundation; +## version 2.1 of the License. +## +## This library 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 +## Lesser General Public License for more details. +## +## You should have received a copy of the GNU Lesser General Public +## License along with this library; if not, write to the Free Software +## Foundation, Inc., 51 Franklin Street, Fifth Floor, +## Boston, MA 02110-1301 USA + +SUBDIRS = settingsd diff --git a/include/settingsd/Makefile.am b/include/settingsd/Makefile.am new file mode 100644 index 0000000..c81f8a1 --- /dev/null +++ b/include/settingsd/Makefile.am @@ -0,0 +1,29 @@ +## Copyright 2013 Intel Corporation All Rights Reserved. +## +## This library is free software; you can redistribute it and/or +## modify it under the terms of the GNU Lesser General Public +## License as published by the Free Software Foundation; +## version 2.1 of the License. +## +## This library 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 +## Lesser General Public License for more details. +## +## You should have received a copy of the GNU Lesser General Public +## License along with this library; if not, write to the Free Software +## Foundation, Inc., 51 Franklin Street, Fifth Floor, +## Boston, MA 02110-1301 USA + +## --------------------------------------------------------- +## settingsd plugin library +## --------------------------------------------------------- +pkginclude_HEADERS = \ + settings_api.hpp \ + plugin.hpp \ + registrar.hpp \ + response_callback.hpp \ + glib_traits.hpp \ + json_glib_traits.hpp \ + smart_ptr.hpp \ + reverse_lock.hpp diff --git a/include/settingsd/glib_traits.hpp b/include/settingsd/glib_traits.hpp new file mode 100644 index 0000000..db34bcb --- /dev/null +++ b/include/settingsd/glib_traits.hpp @@ -0,0 +1,94 @@ +/** + * @file glib_traits.hpp + * + * @brief @c GLib traits. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#ifndef IVI_SETTINGS_GLIB_TRAITS_HPP +#define IVI_SETTINGS_GLIB_TRAITS_HPP + +#include <glib.h> +#include <json-glib/json-glib.h> + + +namespace ivi +{ + namespace settings + { + template<typename T> struct traits; + + template<> + struct traits<GVariant> + { + static void + release(GVariant * p) + { + if (p != nullptr) + g_variant_unref(p); + } + }; + + template<> + struct traits<GVariantIter> + { + static void release(GVariantIter * p) { g_variant_iter_free(p); } + }; + + template<> + struct traits<gchar> + { + static void release(gchar * p) { g_free(p); } + }; + + template<> + struct traits<GError> + { + static void release(GError * p) + { + if (p != nullptr) + g_error_free(p); + } + }; + + template<> + struct traits<GMainLoop> + { + static void release(GMainLoop * p) + { + if (p != nullptr) + g_main_loop_unref(p); + } + }; + + } +} + + +#endif /* IVI_SETTINGS_GLIB_TRAITS_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/include/settingsd/json_glib_traits.hpp b/include/settingsd/json_glib_traits.hpp new file mode 100644 index 0000000..e5bcac4 --- /dev/null +++ b/include/settingsd/json_glib_traits.hpp @@ -0,0 +1,101 @@ +/** + * @file json_glib_traits.hpp + * + * @brief @c JSON-GLib traits. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#ifndef IVI_SETTINGS_JSON_GLIB_TRAITS_HPP +#define IVI_SETTINGS_JSON_GLIB_TRAITS_HPP + +#include <glib.h> +#include <json-glib/json-glib.h> + + +namespace ivi +{ + namespace settings + { + template<typename T> struct traits; + + template<> + struct traits<JsonNode> + { + static void release(JsonNode * p) { json_node_free(p); } + }; + + template<> + struct traits<JsonParser> + { + static void + release(JsonParser * p) + { + if (p != nullptr) + g_object_unref(p); + } + }; + + template<> + struct traits<JsonReader> + { + static void + release(JsonReader * p) + { + if (p != nullptr) + g_object_unref(p); + } + }; + + template<> + struct traits<JsonBuilder> + { + static void + release(JsonBuilder * p) + { + if (p != nullptr) + g_object_unref(p); + } + }; + + template<> + struct traits<JsonGenerator> + { + static void + release(JsonGenerator * p) + { + if (p != nullptr) + g_object_unref(p); + } + }; + + } +} + + +#endif /* IVI_SETTINGS_JSON_GLIB_TRAITS_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/include/settingsd/plugin.hpp b/include/settingsd/plugin.hpp new file mode 100644 index 0000000..11a1030 --- /dev/null +++ b/include/settingsd/plugin.hpp @@ -0,0 +1,103 @@ +/** + * @file plugin.hpp + * + * @brief Settings plugin interface header. + * + * All settingsd settings plugins must subclass the @c settings_plugin + * class declared in this header. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2012, 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + + +#ifndef IVI_SETTINGS_PLUGIN_HPP +#define IVI_SETTINGS_PLUGIN_HPP + +#include <settingsd/settings_api.hpp> + +#include <string> + + +/** + * @namespace ivi + * + * @brief @c Unofficial namespace in which Tizen IVI symbols are + * found. + */ +namespace ivi +{ + /** + * @namespace settings + * + * @brief @c settingsd namespace in which all @c settingsd classes, free + * functions, etc are found. + */ + namespace settings + { + class response_callback; + + /** + * @class plugin plugin.hpp <settingsd/plugin.hpp> + * + * @brief Settings daemon plugin interface. + * + * This is an abstract base class that defines the interface for + * concrete settings plugins. + */ + class SETTINGS_API plugin + { + public: + + /// Destructor. + virtual ~plugin(); + + /** + * @brief Settings plugin ID. + * + * The settings ID, such as "@c bluetooth" is a string that + * uniquely identifies the settings plugin. + */ + virtual std::string const & id() const = 0; + + /** + * @brief Handle the given settings request. + * + * @param[in] request JSON formatted settings request. + * @param[in] response Callback object that is called when + * request handling completes, and a + * response is available. + */ + virtual void handle_request(std::string request, + response_callback response) = 0; + + }; + + } +} + +#endif /* IVI_SETTINGS_PLUGIN_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/include/settingsd/registrar.hpp b/include/settingsd/registrar.hpp new file mode 100644 index 0000000..395fc5b --- /dev/null +++ b/include/settingsd/registrar.hpp @@ -0,0 +1,102 @@ +/** + * @file registrar.hpp + * + * @brief Settings plugin registration handler. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#ifndef IVI_SETTINGS_REGISTRAR_HPP +#define IVI_SETTINGS_REGISTRAR_HPP + +#include <settingsd/settings_api.hpp> + +#include <string> +#include <memory> + + +namespace ivi +{ + namespace settings + { + class manager; + class plugin; + + /** + * @class registrar + * + * @brief Handles registration of settings plugins. + * + * Plugins will register themselves with the settings daemon + * through an instance of this class. + * + * This class exists to avoid exposing the @c manager object + * directly to plugins, as well as to address cyclic + * dependencies. + */ + class SETTINGS_API registrar + { + public: + + /** + * Constructor. + * + * @param[in] m Reference to the settings manager. + */ + registrar(manager & m); + + /** + * Register settings plugin. + * + * @param[in] p Pointer to the settings plugin. + * @return @c true on success. + */ + bool register_setting(std::unique_ptr<plugin> p); + + private: + + /** + * @name Prevent copying + */ + //@{ + registrar(registrar const &) = delete; + registrar & operator=(registrar const &) = delete; + //@} + + private: + + /// The settings manager. + manager & manager_; + + }; + + } +} + + +#endif /* IVI_SETTINGS_REGISTRAR_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/include/settingsd/response_callback.hpp b/include/settingsd/response_callback.hpp new file mode 100644 index 0000000..3c59a79 --- /dev/null +++ b/include/settingsd/response_callback.hpp @@ -0,0 +1,166 @@ +/** + * @file response_callback.hpp + * + * @brief Settings response callback header. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2012, 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + + +#ifndef IVI_SETTINGS_RESPONSE_CALLBACK_HPP +#define IVI_SETTINGS_RESPONSE_CALLBACK_HPP + +#include <settingsd/settings_api.hpp> + +#include <libwebsockets.h> +#include <json-glib/json-glib.h> + +#include <functional> +#include <string> + + +namespace ivi +{ + namespace settings + { + template<typename T> class smart_ptr; + + /** + * @class response_callback response_callback.hpp <settingsd/response_callback.hpp> + * + * @brief Callback that handles sending response to Settings app. + * + * A @c response_callback sends a JSON formatted response string + * to the Settings app. It is up to the specific settings plugin + * to decide what goes in to the response. + */ + class SETTINGS_API response_callback + { + public: + + /// Constructor + response_callback(struct libwebsocket * wsi, + std::string type, + std::string transaction_id); + + /// Destructor. + ~response_callback(); + + /** + * Send (successful) response to Settings app. + * + * The settings daemon requires that plugins use the json-glib + * library to build JSON respons strings. Plugins will pass a + * callback function @a response_builder that uses to the + * json-glib high level "builder" API to append the results of + * the successful Settings app request to the JSON response + * string. Plugins should take care to only use the builder + * functions that add members and their corresponding to + * values. They should not attempt to start or end the top + * level JSON object. That will be automatically handled by + * this class. + * + * @param[in] response_builder Callback function that appends + * JSON formatted response data. + */ + bool send_response( + std::function<void(JsonBuilder *)> response_builder); + + /** + * Send error response to Settings app. + * + * @param[in] error_message Free form error message. + */ + bool send_error(std::string error_message); + + /** + * The settings type/ID associated with the request and + * response. + * + * @note This method is generally used for debugging purposes, + * alone. + */ + std::string const & type() const { return type_; } + + private: + + /** + * Add string value to the response. If the string is empty a + * null JSON value will be added instead. + */ + void add_string_value(JsonBuilder * builder, + std::string const & name, + std::string const & value); + + /** + * Begin the JSON formatted response to the Settings app + * request. + * + * The appropriate "header" information will be prepended to the + * response, such as transaction ID and result success or + * failure. + * + * @param[in] result @c "succeeded" or @c "failed" + */ + smart_ptr<JsonBuilder> begin_response(char const * result); + + /** + * End the JSON formatted response to the Settings app request. + */ + void end_response(smart_ptr<JsonBuilder> const & builder); + + /** + * Send the JSON formatted response to the Settings app + * request over the corresponding websocket. + */ + bool send_payload(smart_ptr<JsonBuilder> const & builder); + + private: + + /** + * Pointer to the websocket through which the response will be + * sent to the Settings app. + */ + struct libwebsocket * const wsi_; + + /** + * Settings type (e.g. "bluetooth", "wifi", etc). + */ + std::string const type_; + + /** + * Transaction/request ID created by Settings app. + */ + std::string const transaction_id_; + + }; + + } +} + +#endif /* IVI_SETTINGS_RESPONSE_CALLBACK_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/include/settingsd/reverse_lock.hpp b/include/settingsd/reverse_lock.hpp new file mode 100644 index 0000000..957e3e0 --- /dev/null +++ b/include/settingsd/reverse_lock.hpp @@ -0,0 +1,82 @@ +/** + * @file reverse_lock.hpp + * + * @brief C++11 style smart pointer for use by settings plug-ins. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#ifndef IVI_SETTINGS_REVERSE_LOCK_HPP +#define IVI_SETTINGS_REVERSE_LOCK_HPP + + +namespace ivi +{ + namespace settings + { + /** + * @typename reverse_lock + * + * @brief Mutex implementation that reverse the lock/unlock + * operations. + */ + template<typename T> + class reverse_lock + { + public: + + constexpr reverse_lock(T & m) : mutex_(m) {} + + /// Unlock the underlying mutex. + void lock() { return mutex_.unlock(); } + + /// Lock the underlying mutex. + void unlock() { return mutex_.lock(); } + + private: + + /** + * @name Prevent copying + */ + //@{ + reverse_lock(reverse_lock const &) = delete; + reverse_lock & operator=(reverse_lock const &) = delete; + //@} + + private: + + /// The underlying mutex. + T & mutex_; + + }; + + } +} + + +#endif /* IVI_SETTINGS_REVERSE_LOCK_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/include/settingsd/settings_api.hpp b/include/settingsd/settings_api.hpp new file mode 100644 index 0000000..b14023d --- /dev/null +++ b/include/settingsd/settings_api.hpp @@ -0,0 +1,70 @@ +/** + * @file settings_api.hpp + * + * @brief Settings plugin library export macros. + * + * The Settings plugin library uses these macros to export the + * settings plugin API from the settings library as needed. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2012, 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + * + * @note This header is internal. Settings provider plugin implementors + * should write their own library/symbol export macros as + * needed. + */ + + +#ifndef SETTINGS_API_HPP +#define SETTINGS_API_HPP + +# if defined _WIN32 || defined __CYGWIN__ +# ifdef SETTINGS_BUILDING_DLL +# ifdef __GNUC__ +# define SETTINGS_API __attribute__ ((dllexport)) +# else +# define SETTINGS_API __declspec(dllexport) +# endif +# else +# ifdef __GNUC__ +# define SETTINGS_API __attribute__ ((dllimport)) +# else +# define SETTINGS_API __declspec(dllimport) +# endif +# endif +# define SETTINGS_LOCAL +# else +# if __GNUC__ >= 4 +# define SETTINGS_API __attribute__ ((visibility ("default"))) +# define SETTINGS_LOCAL __attribute__ ((visibility ("hidden"))) +# else +# define SETTINGS_API +# define SETTINGS_LOCAL +# endif +# endif + +#endif /* SETTINGS_API_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/include/settingsd/smart_ptr.hpp b/include/settingsd/smart_ptr.hpp new file mode 100644 index 0000000..76d00fa --- /dev/null +++ b/include/settingsd/smart_ptr.hpp @@ -0,0 +1,302 @@ +/** + * @file smart_ptr.hpp + * + * @brief C++11 style smart pointer for use by settings plug-ins. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#ifndef IVI_SETTINGS_SMART_PTR_HPP +#define IVI_SETTINGS_SMART_PTR_HPP + +#include <cstddef> +#include <utility> +#include <functional> + + +namespace ivi +{ + namespace settings + { + /** + * @typename smart_ptr + * + * @brief C++11 style smart pointer for use by settings plug-ins. + * + * This typename exposes a C++11-style smart pointer interface to + * allow RAII based handling of resources provided by third party + * libraries, such as Glib. Core functionality is implemented in + * traits that this typename template leverages. + */ + template<typename T> + class smart_ptr + { + public: + typedef T * pointer; + typedef T element_type; + typedef traits<T> traits_type; + + constexpr smart_ptr() : p_(nullptr) {} + + constexpr smart_ptr(std::nullptr_t) : p_(nullptr) {} + + explicit smart_ptr(pointer p) : p_(p) {} + + smart_ptr(smart_ptr&& u) : p_(u.p_) { u.p_ = nullptr; } + + ~smart_ptr() { traits_type::release(p_); } + + smart_ptr & + operator=(smart_ptr && r) + { + if (this != &r) { + smart_ptr<T> tmp(r); + swap(tmp); + } + + return *this; + } + + smart_ptr & + operator=(std::nullptr_t) + { + reset(nullptr); + } + + pointer + release() + { + pointer const old = p_; + p_ = nullptr; + + return old; + } + + void + reset(pointer p = pointer()) + { + smart_ptr<T> tmp(p); + swap(tmp); + } + + void swap(smart_ptr& other) { std::swap(p_, other.p_); } + + pointer get() const { return p_; } + + explicit operator bool() const { return p_ != nullptr; } + + typename std::add_lvalue_reference<T>::type + operator*() const + { + /** + * @todo Throw exception if @c p_ @c == @c nullptr. + */ + return *p_; + } + + pointer operator->() const { return p_; } + + private: + + /** + * @name Prevent copying + */ + //@{ + smart_ptr(smart_ptr const &) = delete; + smart_ptr & operator=(smart_ptr const &) = delete; + //@} + + private: + + /// Pointer to the object being managed. + T * p_; + + }; + + template<typename T1, typename T2> + bool + operator==(smart_ptr<T1> const & x, smart_ptr<T2> const & y) + { + return x.get() == y.get(); + } + + template<typename T1, typename T2> + bool + operator!=(smart_ptr<T1> const & x, smart_ptr<T2> const & y) + { + return x.get() != y.get(); + } + + template<typename T1, typename T2> + bool + operator<(smart_ptr<T1> const & x, smart_ptr<T2> const & y) + { + typedef typename + std::common_type<typename smart_ptr<T1>::pointer, + typename smart_ptr<T2>::pointer>::type type; + + return std::less<type>()(x.get(), y.get()); + } + + + template<typename T1, typename T2> + bool operator<=(smart_ptr<T1> const & x, smart_ptr<T2> const & y) + { + return !(y < x); + } + + template<typename T1, typename T2> + bool + operator>(smart_ptr<T1> const & x, smart_ptr<T2> const & y) + { + return (y < x); + } + + template<typename T1, typename T2> + bool + operator>=(smart_ptr<T1> const & x, smart_ptr<T2> const & y) + { + return !(x < y); + } + + template<typename T> + bool + operator==(smart_ptr<T> const & x, std::nullptr_t) noexcept + { + return !x; + } + + template<typename T> + bool + operator==(std::nullptr_t, smart_ptr<T> const & x) noexcept + { + return !x; + } + + template<typename T> + bool + operator!=(smart_ptr<T> const & x, std::nullptr_t) noexcept + { + return static_cast<bool>(x); + } + + template<typename T> + bool + operator!=(std::nullptr_t, smart_ptr<T> const & x) noexcept + { + return static_cast<bool>(x); + } + + template<typename T> + bool + operator<(smart_ptr<T> const & x, std::nullptr_t) + { + return std::less<typename smart_ptr<T>::pointer>()(x.get(), nullptr); + } + + template<typename T> + bool + operator<(std::nullptr_t, smart_ptr<T> const & y) + { + return std::less<typename smart_ptr<T>::pointer>()(nullptr, y.get()); + } + + template<typename T> + bool + operator<=(smart_ptr<T> const & x, std::nullptr_t) + { + return nullptr < x; + } + + template<typename T> + bool + operator<=(std::nullptr_t, smart_ptr<T> const & y) + { + return y < nullptr; + } + + template<typename T> + bool + operator>(smart_ptr<T> const & x, std::nullptr_t) + { + return !(nullptr < x); + } + + template<typename T> + bool + operator>(std::nullptr_t, smart_ptr<T> const & y) + { + return !(y < nullptr); + } + + template<typename T> + bool + operator>=(smart_ptr<T> const & x, std::nullptr_t) + { + return !(x < nullptr); + } + + template<typename T> + bool + operator>=(std::nullptr_t, smart_ptr<T> const & y) + { + return !(nullptr < y); + } + + } +} + +namespace std +{ + template<typename T> + void + swap(ivi::settings::smart_ptr<T> & lhs, + ivi::settings::smart_ptr<T> & rhs) + { + lhs.swap(rhs); + } + + template<typename T> + struct hash<ivi::settings::smart_ptr<T>> + { + typedef ivi::settings::smart_ptr<T> argument_type; + typedef std::size_t result_type; + + hash(); + + result_type + operator()(argument_type const & p) const + { + typedef typename argument_type::pointer key_type; + + return hash<key_type>(p.get()); + } + }; +} + +#endif /* IVI_SETTINGS_SMART_PTR_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/lib/Makefile.am b/lib/Makefile.am new file mode 100644 index 0000000..276a61f --- /dev/null +++ b/lib/Makefile.am @@ -0,0 +1,49 @@ +## Copyright 2013 Intel Corporation All Rights Reserved. +## +## This library is free software; you can redistribute it and/or +## modify it under the terms of the GNU Lesser General Public +## License as published by the Free Software Foundation; +## version 2.1 of the License. +## +## This library 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 +## Lesser General Public License for more details. +## +## You should have received a copy of the GNU Lesser General Public +## License along with this library; if not, write to the Free Software +## Foundation, Inc., 51 Franklin Street, Fifth Floor, +## Boston, MA 02110-1301 USA + +## --------------------------------------------------------- +## settings plugin library +## --------------------------------------------------------- +lib_LTLIBRARIES = libsettings.la + +libsettings_la_SOURCES = \ + loader.cpp \ + manager.cpp \ + plugin.cpp \ + registrar.cpp \ + response_callback.cpp + +libsettings_la_CPPFLAGS = -DSETTINGS_BUILDING_DLL -I$(top_srcdir)/include + +if SETTINGS_USE_GCC_SYMBOL_VISIBILITY + SETTINGS_PLUGIN_CXXFLAGS = -fvisibility=hidden -fvisibility-inlines-hidden +else + SETTINGS_PLUGIN_CXXFLAGS = +endif + +libsettings_la_CXXFLAGS = \ + $(SETTINGS_PLUGIN_CXXFLAGS) \ + $(BOOST_CPPFLAGS) \ + $(JSON_GLIB_CFLAGS) + +libsettings_la_LIBADD = \ + $(BOOST_FILESYSTEM_LIB) \ + $(JSON_GLIB_LIBS) + +noinst_HEADERS = \ + loader.hpp \ + manager.hpp diff --git a/lib/loader.cpp b/lib/loader.cpp new file mode 100644 index 0000000..6423686 --- /dev/null +++ b/lib/loader.cpp @@ -0,0 +1,87 @@ +/** + * @file loader.cpp + * + * @brief Settings plugin loader implementation. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2012, 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + + +#include "loader.hpp" +#include "manager.hpp" +#include <settingsd/plugin.hpp> +#include <settingsd/registrar.hpp> + +#include <stdexcept> +#include <dlfcn.h> + + +#ifdef __GNUC__ +/// We use this macro to silence @c -pedantic warnings from g++ that +/// there is no way to properly fix. +# define IVI_SETTINGS_EXTENSION __extension__ +#else +# define IVI_SETTINGS_EXTENSION +#endif /* __GNUC__ */ + + +ivi::settings::loader::loader(std::string const & plugin_name, + ivi::settings::manager & mgr) + : handle_(dlopen(plugin_name.c_str(), RTLD_LAZY | RTLD_GLOBAL)) +{ + if (handle_ == nullptr) { + throw std::logic_error(dlerror()); + } + + // Reset any lingering dynamic linking related errors (see + // dlopen(3)). + dlerror(); + + // Retrieve the settings factory and destroyer functions. + typedef bool(*factory_type)(registrar &); + factory_type const register_settings = + IVI_SETTINGS_EXTENSION reinterpret_cast<factory_type>( + dlsym(handle_, + "register_settings")); + + if (register_settings == nullptr) + throw std::logic_error(dlerror()); + + // Now create the underlying settings implementation. + + registrar r(mgr); + if (!register_settings(r)) + throw std::runtime_error("Unable to make \"" + + plugin_name + + "\" settings plugin"); +} + +ivi::settings::loader::~loader() +{ + dlclose(handle_); +} + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/lib/loader.hpp b/lib/loader.hpp new file mode 100644 index 0000000..22f9308 --- /dev/null +++ b/lib/loader.hpp @@ -0,0 +1,94 @@ +/** + * @file loader.hpp + * + * @brief Settings plugin loader header. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2012, 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + * + * @note This header is internal. + */ + + +#ifndef IVI_SETTINGS_LOADER_HPP +#define IVI_SETTINGS_LOADER_HPP + +#include <string> + + +namespace ivi +{ + namespace settings + { + class manager; + + /** + * @class loader + * + * @brief Class that dynamically loads settings plugins. + * + * This class provides the native backend implementations of the + * Tizen IVI Settings app. It delegates all method alls on to a + * dynamically loaded settings plugin. + */ + class loader + { + public: + + /// Constructor + /** + * @param[in] plugin_name Path, including filename, of settings + * plugin. + * @param[in] mgr Settings manager. + */ + loader(std::string const & plugin_name, + manager & mgr); + + /// Destructor. + ~loader(); + + private: + + /** + * @name Prevent copying + */ + //@{ + loader(loader const &) = delete; + loader & operator=(loader const &) = delete; + //@} + + private: + + /// Handle to provider plugin. + void * const handle_; + + }; + + } +} + +#endif /* IVI_SETTINGS_LOADER_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/lib/manager.cpp b/lib/manager.cpp new file mode 100644 index 0000000..0b497c9 --- /dev/null +++ b/lib/manager.cpp @@ -0,0 +1,192 @@ +/** + * @file manager.cpp + * + * @brief Settings manager implementation. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2012, 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + + +#include "config.hpp" +#include "manager.hpp" +#include <settingsd/plugin.hpp> +#include <settingsd/response_callback.hpp> +#include <settingsd/json_glib_traits.hpp> +#include <settingsd/smart_ptr.hpp> + +#include <gmodule.h> + +#include <boost/filesystem.hpp> + + +ivi::settings::manager::manager(std::string const & dir) + : loaders_() + , settings_() +{ + load_settings(dir); +} + +ivi::settings::manager::~manager() +{ +} + +bool +ivi::settings::manager::register_setting(std::unique_ptr<plugin> p) +{ + std::string const & id = p->id(); + + auto const result = + settings_.insert(std::make_pair(id, std::move(p))); + + if (!result.second) + std::cerr << "Settings plugin registration for \"" + << id << "\" failed." << std::endl; + + return result.second; +} + +void +ivi::settings::manager::load_settings(std::string const & dir) +{ + if (dir.length() == 0) + throw std::logic_error("Zero length settings plugin directory path."); + + namespace fs = boost::filesystem; + + // Find all settings plugins in the plugin directory. + fs::path settings_dir(dir); + + if (fs::is_directory(settings_dir)) { + // Iterate over directory entries, create settings instances + // for each settings plugin, and store in settings map. + + fs::directory_iterator const end; + for (fs::directory_iterator i(settings_dir); i != end; ++i) { + try { + fs::path const & plugin_path = (*i).path(); + + // Verify that the plugin is actually a file with the + // appropriate extension (e.g. ".so"). + // + // Note that the .extension() method returns a string like + // ".so" whereas G_MODULE_SUFFIX is preprocessor symbol/string + // like "so". We prepend a period to G_MODULE_SUFFIX using + // standard string literal concatenation. + if (!fs::is_regular_file(plugin_path) + || plugin_path.extension() != "." G_MODULE_SUFFIX) + continue; + + std::string const & plugin_name = plugin_path.string(); + + std::unique_ptr<loader> plugin(new loader(plugin_name, *this)); + + loaders_.push_back(std::move(plugin)); + } + catch (std::logic_error & e) { + /** + * @todo I really hate catching an exception like this, but I + * really don't want to resort to a construct/init() + * style of object initialization. Fix. + */std::cerr << "Error loading plugin: " << e.what() << "\n"; + } + } + + if (settings_.size() == 0) { + std::cerr << "Settings plugin directory \"" + << dir << "\" has no plugins.\n"; + } else { + std::cerr << "Registered settings plugins: \n"; + for (auto const & i : settings_) + std::cerr << "\t" << i.first << '\n'; + } + } else { + std::cerr << "Settings plugin directory \"" + << dir << "\" does not exist.\n"; + } +} + +void +ivi::settings::manager::dispatch(std::string request, + struct libwebsocket * wsi) +{ + if (request.empty()) { + response_callback response(wsi, std::string(), std::string()); + response.send_error("Empty settings request."); + } + + smart_ptr<JsonParser> const parser(json_parser_new()); + json_parser_load_from_data(parser.get(), request.c_str(), -1, nullptr); + + JsonReader * const reader = json_reader_new(json_parser_get_root(parser.get())); + smart_ptr<JsonReader> const safe_reader(reader); + + // Retrieve setting name and transcation ID from the JSON request + // string. + char const * type = nullptr; + if (json_reader_read_member(reader, "type")) { + type = json_reader_get_string_value(reader); + } + json_reader_end_member(reader); + + /** + * @todo Allow transaction ID to be null? + */ + char const * transaction_id = ""; + if (json_reader_read_member(reader, "transactionid")) { + transaction_id = json_reader_get_string_value(reader); + } + json_reader_end_member(reader); + + response_callback response(wsi, + type == nullptr ? "" : type, + transaction_id); + + std::string error; + if (type != nullptr) { + // Dispatch the request to the corresponding settings plugin. + auto i = settings_.find(type); + if (i != settings_.end()) + (*i).second->handle_request(request, response); + else { + error = + std::string("Settings type \"") + + type + "\" not supported."; + + response.send_error(error); + } + } else { + error = + "Settings type not specified in request.\n" + "Supported plugins:\n"; + + for (auto const & i : settings_) + error += "\t" + i.first + "\n"; + + response.send_error(error); + } +} + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/lib/manager.hpp b/lib/manager.hpp new file mode 100644 index 0000000..e768deb --- /dev/null +++ b/lib/manager.hpp @@ -0,0 +1,141 @@ +/** + * @file manager.hpp + * + * @brief Settings manager header. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + * + * @note This header is internal. + */ + +#ifndef IVI_SETTINGS_MANAGER_HPP +#define IVI_SETTINGS_MANAGER_HPP + +#include "loader.hpp" + +#include <settingsd/plugin.hpp> + +#include <libwebsockets.h> + +#include <string> +#include <map> +#include <vector> +#include <memory> + + +namespace ivi +{ + namespace settings + { + /** + * @class manager + * + * @brief The @c manager class is repository for all + * settings plugins. + * + * This class exposes the basic settings interface, and hides the + * underlying settings plugin details from the caller. All + * interaction with settings plugins is done through this class. + */ + class SETTINGS_API manager + { + public: + + /** + * Constructor. + * + * @param[in] dir The settings plugin directory path. + */ + manager(std::string const & dir); + + /// Destructor. + ~manager(); + + /// Register settings plugin with the settings daemon. + bool register_setting(std::unique_ptr<plugin> p); + + /** + * Dispatch request to appropriate settings plugin. + * + * @param[in] request JSON formatted request string. + * @param[in] wsi Websocket through which response will be + * sent. + */ + void dispatch(std::string request, libwebsocket * wsi); + + private: + + /** + * @name Prevent copying + */ + //@{ + manager(manager const &) = delete; + manager & operator=(manager const &) = delete; + //@} + + /// Load settings. + void load_settings(std::string const & dir); + + private: + + /** + * @todo A map may be overkill if only a few plugins will ever be + * registered. It may actually be more efficient from both + * a space and time point of view to simply use an array or + * linked list - although those alternatives would force us + * to explicitly prevent registration of settings plugins + * with duplicate names. + */ + typedef std::map<std::string, std::unique_ptr<plugin>> map_type; + + /** + * List of settings plugin loaders. + * + * Each plugin could potentially register multiple plugins so we + * keep track of the loaders independently. We only keep these + * around so that we can gracefully close the plugins if + * necessary. + * + * @note This member must come before the settings plugin map, + * @c settings_, so that the plugins are still in memory + * (i.e. not @c dlclose()d) before they are destructed. + * Remember that the members are destroyed in the reverse + * order they are initialized. + */ + std::vector<std::unique_ptr<loader>> loaders_; + + /// Map of settings name to @c settings instance. + map_type settings_; + + }; + + } +} + + +#endif /* IVI_SETTINGS_MANAGER_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/lib/plugin.cpp b/lib/plugin.cpp new file mode 100644 index 0000000..c1c5635 --- /dev/null +++ b/lib/plugin.cpp @@ -0,0 +1,51 @@ +/** + * @file settings_plugin.cpp + * + * @brief Settings plugin implementation. + * + * The @c settingsd::settings_plugin abstract base class destructor is + * found in this source file. It is defined out-of-line to address + * RTTI related issues that occur when both a virtual destructor is + * in-lined and g++ symbol visibility is enabled. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2012, 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + + +#include <settingsd/plugin.hpp> + + +ivi::settings::plugin::~plugin() +{ + /** + * @note This destructor is intentionally defined out-of-line to + * address RTTI related issues that occur when both a virtual + * destructor is in-lined and g++ symbol visibility is + * enabled. + */ +} + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/lib/registrar.cpp b/lib/registrar.cpp new file mode 100644 index 0000000..f252c84 --- /dev/null +++ b/lib/registrar.cpp @@ -0,0 +1,49 @@ +/** + * @file registrar.cpp + * + * @brief Settings registrar implementation. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2012, 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#include <settingsd/registrar.hpp> +#include <settingsd/plugin.hpp> + +#include "manager.hpp" + + +ivi::settings::registrar::registrar(ivi::settings::manager & m) + : manager_(m) +{ +} + +bool +ivi::settings::registrar::register_setting(std::unique_ptr<plugin> p) +{ + return manager_.register_setting(std::move(p)); +} + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/lib/response_callback.cpp b/lib/response_callback.cpp new file mode 100644 index 0000000..6eb3eaa --- /dev/null +++ b/lib/response_callback.cpp @@ -0,0 +1,176 @@ +/** + * @file response_callback.cpp + * + * @brief Settings plugin response_callback implementation. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2012, 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#include <settingsd/response_callback.hpp> +#include <settingsd/glib_traits.hpp> +#include <settingsd/json_glib_traits.hpp> +#include <settingsd/smart_ptr.hpp> + +#include <cstring> +#include <algorithm> +#include <iostream> + + +ivi::settings::response_callback::response_callback( + struct libwebsocket * wsi, + std::string type, + std::string transaction_id) + : wsi_(wsi) + , type_(type) + , transaction_id_(transaction_id) +{ +} + +ivi::settings::response_callback::~response_callback() +{ +} + +bool +ivi::settings::response_callback::send_response( + std::function<void(JsonBuilder *)> response_builder) +{ + smart_ptr<JsonBuilder> const builder = begin_response("succeeded"); + + // Append successful Settings app results to the JSON formatted + // response. + response_builder(builder.get()); + + end_response(builder); + + return send_payload(builder); +} + +bool +ivi::settings::response_callback::send_error(std::string error_message) +{ + smart_ptr<JsonBuilder> builder = begin_response("failed"); + + json_builder_set_member_name(builder.get(), "reason");; + json_builder_add_string_value(builder.get(), error_message.c_str()); + + end_response(builder); + + return send_payload(builder); +} + +void +ivi::settings::response_callback::add_string_value( + JsonBuilder * builder, + std::string const & name, + std::string const & value) +{ + json_builder_set_member_name(builder, name.c_str()); + if (value.empty()) + json_builder_add_null_value(builder); + else + json_builder_add_string_value(builder, value.c_str()); +} + +ivi::settings::smart_ptr<JsonBuilder> +ivi::settings::response_callback::begin_response(char const * result) +{ + // Construct JSON response. + smart_ptr<JsonBuilder> safe_builder(json_builder_new()); + JsonBuilder * const builder = safe_builder.get(); + + json_builder_begin_object(builder); + + add_string_value(builder, "type", type_); + add_string_value(builder, "transactionid", transaction_id_); + + json_builder_set_member_name(builder, "result"); + json_builder_add_string_value(builder, result); + + return safe_builder; +} + +void +ivi::settings::response_callback::end_response( + ivi::settings::smart_ptr<JsonBuilder> const & builder) +{ + json_builder_end_object(builder.get()); +} + +bool +ivi::settings::response_callback::send_payload( + ivi::settings::smart_ptr<JsonBuilder> const & builder) +{ + smart_ptr<JsonGenerator> const generator(json_generator_new()); + smart_ptr<JsonNode> const root(json_builder_get_root(builder.get())); + json_generator_set_root(generator.get(), root.get()); + + gchar * const response = + json_generator_to_data(generator.get(), nullptr); + + smart_ptr<gchar> safe_response(response); + + if (response == nullptr) { + g_critical("Unable to generate JSON response for:\n" + " type: %s\n" + " transactionid: %s\n", + type_.c_str(), + transaction_id_.c_str()); + + return false; + } + + g_debug("Sending response: %s\n", response); + + size_t const payload_len = strlen(response); + + // libwebsockets wants a sequence of octets (unsigned char *) rather + // than characters. + typedef std::vector<unsigned char> vector_type; + + vector_type::size_type const buf_len = + LWS_SEND_BUFFER_PRE_PADDING + + payload_len + + LWS_SEND_BUFFER_POST_PADDING; + + vector_type buf(buf_len); + unsigned char * const payload = + buf.data() + LWS_SEND_BUFFER_PRE_PADDING; + + // Copy the string into the buffer after libwebsockets pre-padding. + std::copy(response, + response + payload_len, + payload); + + int const count = libwebsocket_write(wsi_, + payload, + payload_len, + LWS_WRITE_TEXT); + + return count >= 0; +} + + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/m4/.gitignore b/m4/.gitignore new file mode 100644 index 0000000..62c882b --- /dev/null +++ b/m4/.gitignore @@ -0,0 +1,5 @@ +# Ignore everything in this directory +* +# Except this file +!.gitignore +!ax*.m4
\ No newline at end of file diff --git a/m4/ax_boost_base.m4 b/m4/ax_boost_base.m4 new file mode 100644 index 0000000..54a2a1b --- /dev/null +++ b/m4/ax_boost_base.m4 @@ -0,0 +1,258 @@ +# =========================================================================== +# http://www.gnu.org/software/autoconf-archive/ax_boost_base.html +# =========================================================================== +# +# SYNOPSIS +# +# AX_BOOST_BASE([MINIMUM-VERSION], [ACTION-IF-FOUND], [ACTION-IF-NOT-FOUND]) +# +# DESCRIPTION +# +# Test for the Boost C++ libraries of a particular version (or newer) +# +# If no path to the installed boost library is given the macro searchs +# under /usr, /usr/local, /opt and /opt/local and evaluates the +# $BOOST_ROOT environment variable. Further documentation is available at +# <http://randspringer.de/boost/index.html>. +# +# This macro calls: +# +# AC_SUBST(BOOST_CPPFLAGS) / AC_SUBST(BOOST_LDFLAGS) +# +# And sets: +# +# HAVE_BOOST +# +# LICENSE +# +# Copyright (c) 2008 Thomas Porschberg <thomas@randspringer.de> +# Copyright (c) 2009 Peter Adolphs +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty provided the copyright notice +# and this notice are preserved. This file is offered as-is, without any +# warranty. + +#serial 20 + +AC_DEFUN([AX_BOOST_BASE], +[ +AC_ARG_WITH([boost], + [AS_HELP_STRING([--with-boost@<:@=ARG@:>@], + [use Boost library from a standard location (ARG=yes), + from the specified location (ARG=<path>), + or disable it (ARG=no) + @<:@ARG=yes@:>@ ])], + [ + if test "$withval" = "no"; then + want_boost="no" + elif test "$withval" = "yes"; then + want_boost="yes" + ac_boost_path="" + else + want_boost="yes" + ac_boost_path="$withval" + fi + ], + [want_boost="yes"]) + + +AC_ARG_WITH([boost-libdir], + AS_HELP_STRING([--with-boost-libdir=LIB_DIR], + [Force given directory for boost libraries. Note that this will override library path detection, so use this parameter only if default library detection fails and you know exactly where your boost libraries are located.]), + [ + if test -d "$withval" + then + ac_boost_lib_path="$withval" + else + AC_MSG_ERROR(--with-boost-libdir expected directory name) + fi + ], + [ac_boost_lib_path=""] +) + +if test "x$want_boost" = "xyes"; then + boost_lib_version_req=ifelse([$1], ,1.20.0,$1) + boost_lib_version_req_shorten=`expr $boost_lib_version_req : '\([[0-9]]*\.[[0-9]]*\)'` + boost_lib_version_req_major=`expr $boost_lib_version_req : '\([[0-9]]*\)'` + boost_lib_version_req_minor=`expr $boost_lib_version_req : '[[0-9]]*\.\([[0-9]]*\)'` + boost_lib_version_req_sub_minor=`expr $boost_lib_version_req : '[[0-9]]*\.[[0-9]]*\.\([[0-9]]*\)'` + if test "x$boost_lib_version_req_sub_minor" = "x" ; then + boost_lib_version_req_sub_minor="0" + fi + WANT_BOOST_VERSION=`expr $boost_lib_version_req_major \* 100000 \+ $boost_lib_version_req_minor \* 100 \+ $boost_lib_version_req_sub_minor` + AC_MSG_CHECKING(for boostlib >= $boost_lib_version_req) + succeeded=no + + dnl On 64-bit systems check for system libraries in both lib64 and lib. + dnl The former is specified by FHS, but e.g. Debian does not adhere to + dnl this (as it rises problems for generic multi-arch support). + dnl The last entry in the list is chosen by default when no libraries + dnl are found, e.g. when only header-only libraries are installed! + libsubdirs="lib" + ax_arch=`uname -m` + if test $ax_arch = x86_64 -o $ax_arch = ppc64 -o $ax_arch = s390x -o $ax_arch = sparc64; then + libsubdirs="lib64 lib lib64" + fi + + dnl first we check the system location for boost libraries + dnl this location ist chosen if boost libraries are installed with the --layout=system option + dnl or if you install boost with RPM + if test "$ac_boost_path" != ""; then + BOOST_CPPFLAGS="-I$ac_boost_path/include" + for ac_boost_path_tmp in $libsubdirs; do + if test -d "$ac_boost_path"/"$ac_boost_path_tmp" ; then + BOOST_LDFLAGS="-L$ac_boost_path/$ac_boost_path_tmp" + break + fi + done + elif test "$cross_compiling" != yes; then + for ac_boost_path_tmp in /usr /usr/local /opt /opt/local ; do + if test -d "$ac_boost_path_tmp/include/boost" && test -r "$ac_boost_path_tmp/include/boost"; then + for libsubdir in $libsubdirs ; do + if ls "$ac_boost_path_tmp/$libsubdir/libboost_"* >/dev/null 2>&1 ; then break; fi + done + BOOST_LDFLAGS="-L$ac_boost_path_tmp/$libsubdir" + BOOST_CPPFLAGS="-I$ac_boost_path_tmp/include" + break; + fi + done + fi + + dnl overwrite ld flags if we have required special directory with + dnl --with-boost-libdir parameter + if test "$ac_boost_lib_path" != ""; then + BOOST_LDFLAGS="-L$ac_boost_lib_path" + fi + + CPPFLAGS_SAVED="$CPPFLAGS" + CPPFLAGS="$CPPFLAGS $BOOST_CPPFLAGS" + export CPPFLAGS + + LDFLAGS_SAVED="$LDFLAGS" + LDFLAGS="$LDFLAGS $BOOST_LDFLAGS" + export LDFLAGS + + AC_REQUIRE([AC_PROG_CXX]) + AC_LANG_PUSH(C++) + AC_COMPILE_IFELSE([AC_LANG_PROGRAM([[ + @%:@include <boost/version.hpp> + ]], [[ + #if BOOST_VERSION >= $WANT_BOOST_VERSION + // Everything is okay + #else + # error Boost version is too old + #endif + ]])],[ + AC_MSG_RESULT(yes) + succeeded=yes + found_system=yes + ],[ + ]) + AC_LANG_POP([C++]) + + + + dnl if we found no boost with system layout we search for boost libraries + dnl built and installed without the --layout=system option or for a staged(not installed) version + if test "x$succeeded" != "xyes"; then + _version=0 + if test "$ac_boost_path" != ""; then + if test -d "$ac_boost_path" && test -r "$ac_boost_path"; then + for i in `ls -d $ac_boost_path/include/boost-* 2>/dev/null`; do + _version_tmp=`echo $i | sed "s#$ac_boost_path##" | sed 's/\/include\/boost-//' | sed 's/_/./'` + V_CHECK=`expr $_version_tmp \> $_version` + if test "$V_CHECK" = "1" ; then + _version=$_version_tmp + fi + VERSION_UNDERSCORE=`echo $_version | sed 's/\./_/'` + BOOST_CPPFLAGS="-I$ac_boost_path/include/boost-$VERSION_UNDERSCORE" + done + fi + else + if test "$cross_compiling" != yes; then + for ac_boost_path in /usr /usr/local /opt /opt/local ; do + if test -d "$ac_boost_path" && test -r "$ac_boost_path"; then + for i in `ls -d $ac_boost_path/include/boost-* 2>/dev/null`; do + _version_tmp=`echo $i | sed "s#$ac_boost_path##" | sed 's/\/include\/boost-//' | sed 's/_/./'` + V_CHECK=`expr $_version_tmp \> $_version` + if test "$V_CHECK" = "1" ; then + _version=$_version_tmp + best_path=$ac_boost_path + fi + done + fi + done + + VERSION_UNDERSCORE=`echo $_version | sed 's/\./_/'` + BOOST_CPPFLAGS="-I$best_path/include/boost-$VERSION_UNDERSCORE" + if test "$ac_boost_lib_path" = ""; then + for libsubdir in $libsubdirs ; do + if ls "$best_path/$libsubdir/libboost_"* >/dev/null 2>&1 ; then break; fi + done + BOOST_LDFLAGS="-L$best_path/$libsubdir" + fi + fi + + if test "x$BOOST_ROOT" != "x"; then + for libsubdir in $libsubdirs ; do + if ls "$BOOST_ROOT/stage/$libsubdir/libboost_"* >/dev/null 2>&1 ; then break; fi + done + if test -d "$BOOST_ROOT" && test -r "$BOOST_ROOT" && test -d "$BOOST_ROOT/stage/$libsubdir" && test -r "$BOOST_ROOT/stage/$libsubdir"; then + version_dir=`expr //$BOOST_ROOT : '.*/\(.*\)'` + stage_version=`echo $version_dir | sed 's/boost_//' | sed 's/_/./g'` + stage_version_shorten=`expr $stage_version : '\([[0-9]]*\.[[0-9]]*\)'` + V_CHECK=`expr $stage_version_shorten \>\= $_version` + if test "$V_CHECK" = "1" -a "$ac_boost_lib_path" = "" ; then + AC_MSG_NOTICE(We will use a staged boost library from $BOOST_ROOT) + BOOST_CPPFLAGS="-I$BOOST_ROOT" + BOOST_LDFLAGS="-L$BOOST_ROOT/stage/$libsubdir" + fi + fi + fi + fi + + CPPFLAGS="$CPPFLAGS $BOOST_CPPFLAGS" + export CPPFLAGS + LDFLAGS="$LDFLAGS $BOOST_LDFLAGS" + export LDFLAGS + + AC_LANG_PUSH(C++) + AC_COMPILE_IFELSE([AC_LANG_PROGRAM([[ + @%:@include <boost/version.hpp> + ]], [[ + #if BOOST_VERSION >= $WANT_BOOST_VERSION + // Everything is okay + #else + # error Boost version is too old + #endif + ]])],[ + AC_MSG_RESULT(yes) + succeeded=yes + found_system=yes + ],[ + ]) + AC_LANG_POP([C++]) + fi + + if test "$succeeded" != "yes" ; then + if test "$_version" = "0" ; then + AC_MSG_NOTICE([[We could not detect the boost libraries (version $boost_lib_version_req_shorten or higher). If you have a staged boost library (still not installed) please specify \$BOOST_ROOT in your environment and do not give a PATH to --with-boost option. If you are sure you have boost installed, then check your version number looking in <boost/version.hpp>. See http://randspringer.de/boost for more documentation.]]) + else + AC_MSG_NOTICE([Your boost libraries seems to old (version $_version).]) + fi + # execute ACTION-IF-NOT-FOUND (if present): + ifelse([$3], , :, [$3]) + else + AC_SUBST(BOOST_CPPFLAGS) + AC_SUBST(BOOST_LDFLAGS) + AC_DEFINE(HAVE_BOOST,,[define if the Boost library is available]) + # execute ACTION-IF-FOUND (if present): + ifelse([$2], , :, [$2]) + fi + + CPPFLAGS="$CPPFLAGS_SAVED" + LDFLAGS="$LDFLAGS_SAVED" +fi + +]) diff --git a/m4/ax_boost_filesystem.m4 b/m4/ax_boost_filesystem.m4 new file mode 100644 index 0000000..18df8f4 --- /dev/null +++ b/m4/ax_boost_filesystem.m4 @@ -0,0 +1,118 @@ +# =========================================================================== +# http://www.gnu.org/software/autoconf-archive/ax_boost_filesystem.html +# =========================================================================== +# +# SYNOPSIS +# +# AX_BOOST_FILESYSTEM +# +# DESCRIPTION +# +# Test for Filesystem library from the Boost C++ libraries. The macro +# requires a preceding call to AX_BOOST_BASE. Further documentation is +# available at <http://randspringer.de/boost/index.html>. +# +# This macro calls: +# +# AC_SUBST(BOOST_FILESYSTEM_LIB) +# +# And sets: +# +# HAVE_BOOST_FILESYSTEM +# +# LICENSE +# +# Copyright (c) 2009 Thomas Porschberg <thomas@randspringer.de> +# Copyright (c) 2009 Michael Tindal +# Copyright (c) 2009 Roman Rybalko <libtorrent@romanr.info> +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty provided the copyright notice +# and this notice are preserved. This file is offered as-is, without any +# warranty. + +#serial 22 + +AC_DEFUN([AX_BOOST_FILESYSTEM], +[ + AC_ARG_WITH([boost-filesystem], + AS_HELP_STRING([--with-boost-filesystem@<:@=special-lib@:>@], + [use the Filesystem library from boost - it is possible to specify a certain library for the linker + e.g. --with-boost-filesystem=boost_filesystem-gcc-mt ]), + [ + if test "$withval" = "no"; then + want_boost="no" + elif test "$withval" = "yes"; then + want_boost="yes" + ax_boost_user_filesystem_lib="" + else + want_boost="yes" + ax_boost_user_filesystem_lib="$withval" + fi + ], + [want_boost="yes"] + ) + + if test "x$want_boost" = "xyes"; then + AC_REQUIRE([AC_PROG_CC]) + CPPFLAGS_SAVED="$CPPFLAGS" + CPPFLAGS="$CPPFLAGS $BOOST_CPPFLAGS" + export CPPFLAGS + + LDFLAGS_SAVED="$LDFLAGS" + LDFLAGS="$LDFLAGS $BOOST_LDFLAGS" + export LDFLAGS + + LIBS_SAVED=$LIBS + LIBS="$LIBS $BOOST_SYSTEM_LIB" + export LIBS + + AC_CACHE_CHECK(whether the Boost::Filesystem library is available, + ax_cv_boost_filesystem, + [AC_LANG_PUSH([C++]) + AC_COMPILE_IFELSE([AC_LANG_PROGRAM([[@%:@include <boost/filesystem/path.hpp>]], + [[using namespace boost::filesystem; + path my_path( "foo/bar/data.txt" ); + return 0;]])], + ax_cv_boost_filesystem=yes, ax_cv_boost_filesystem=no) + AC_LANG_POP([C++]) + ]) + if test "x$ax_cv_boost_filesystem" = "xyes"; then + AC_DEFINE(HAVE_BOOST_FILESYSTEM,,[define if the Boost::Filesystem library is available]) + BOOSTLIBDIR=`echo $BOOST_LDFLAGS | sed -e 's/@<:@^\/@:>@*//'` + if test "x$ax_boost_user_filesystem_lib" = "x"; then + for libextension in `ls $BOOSTLIBDIR/libboost_filesystem*.so* $BOOSTLIBDIR/libboost_filesystem*.dylib* $BOOSTLIBDIR/libboost_filesystem*.a* 2>/dev/null | sed 's,.*/,,' | sed -e 's;^lib\(boost_filesystem.*\)\.so.*$;\1;' -e 's;^lib\(boost_filesystem.*\)\.a*$;\1;' -e 's;^lib\(boost_filesystem.*\)\.dylib$;\1;'` ; do + ax_lib=${libextension} + AC_CHECK_LIB($ax_lib, exit, + [BOOST_FILESYSTEM_LIB="-l$ax_lib"; AC_SUBST(BOOST_FILESYSTEM_LIB) link_filesystem="yes"; break], + [link_filesystem="no"]) + done + if test "x$link_filesystem" != "xyes"; then + for libextension in `ls $BOOSTLIBDIR/boost_filesystem*.{dll,a}* 2>/dev/null | sed 's,.*/,,' | sed -e 's;^\(boost_filesystem.*\)\.dll.*$;\1;' -e 's;^\(boost_filesystem.*\)\.a*$;\1;'` ; do + ax_lib=${libextension} + AC_CHECK_LIB($ax_lib, exit, + [BOOST_FILESYSTEM_LIB="-l$ax_lib"; AC_SUBST(BOOST_FILESYSTEM_LIB) link_filesystem="yes"; break], + [link_filesystem="no"]) + done + fi + else + for ax_lib in $ax_boost_user_filesystem_lib boost_filesystem-$ax_boost_user_filesystem_lib; do + AC_CHECK_LIB($ax_lib, exit, + [BOOST_FILESYSTEM_LIB="-l$ax_lib"; AC_SUBST(BOOST_FILESYSTEM_LIB) link_filesystem="yes"; break], + [link_filesystem="no"]) + done + + fi + if test "x$ax_lib" = "x"; then + AC_MSG_ERROR(Could not find a version of the library!) + fi + if test "x$link_filesystem" != "xyes"; then + AC_MSG_ERROR(Could not link against $ax_lib !) + fi + fi + + CPPFLAGS="$CPPFLAGS_SAVED" + LDFLAGS="$LDFLAGS_SAVED" + LIBS="$LIBS_SAVED" + fi +]) diff --git a/m4/ax_boost_program_options.m4 b/m4/ax_boost_program_options.m4 new file mode 100644 index 0000000..d612f91 --- /dev/null +++ b/m4/ax_boost_program_options.m4 @@ -0,0 +1,108 @@ +# ============================================================================ +# http://www.gnu.org/software/autoconf-archive/ax_boost_program_options.html +# ============================================================================ +# +# SYNOPSIS +# +# AX_BOOST_PROGRAM_OPTIONS +# +# DESCRIPTION +# +# Test for program options library from the Boost C++ libraries. The macro +# requires a preceding call to AX_BOOST_BASE. Further documentation is +# available at <http://randspringer.de/boost/index.html>. +# +# This macro calls: +# +# AC_SUBST(BOOST_PROGRAM_OPTIONS_LIB) +# +# And sets: +# +# HAVE_BOOST_PROGRAM_OPTIONS +# +# LICENSE +# +# Copyright (c) 2009 Thomas Porschberg <thomas@randspringer.de> +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty provided the copyright notice +# and this notice are preserved. This file is offered as-is, without any +# warranty. + +#serial 20 + +AC_DEFUN([AX_BOOST_PROGRAM_OPTIONS], +[ + AC_ARG_WITH([boost-program-options], + AS_HELP_STRING([--with-boost-program-options@<:@=special-lib@:>@], + [use the program options library from boost - it is possible to specify a certain library for the linker + e.g. --with-boost-program-options=boost_program_options-gcc-mt-1_33_1 ]), + [ + if test "$withval" = "no"; then + want_boost="no" + elif test "$withval" = "yes"; then + want_boost="yes" + ax_boost_user_program_options_lib="" + else + want_boost="yes" + ax_boost_user_program_options_lib="$withval" + fi + ], + [want_boost="yes"] + ) + + if test "x$want_boost" = "xyes"; then + AC_REQUIRE([AC_PROG_CC]) + export want_boost + CPPFLAGS_SAVED="$CPPFLAGS" + CPPFLAGS="$CPPFLAGS $BOOST_CPPFLAGS" + export CPPFLAGS + LDFLAGS_SAVED="$LDFLAGS" + LDFLAGS="$LDFLAGS $BOOST_LDFLAGS" + export LDFLAGS + AC_CACHE_CHECK([whether the Boost::Program_Options library is available], + ax_cv_boost_program_options, + [AC_LANG_PUSH(C++) + AC_COMPILE_IFELSE([AC_LANG_PROGRAM([[@%:@include <boost/program_options.hpp> + ]], + [[boost::program_options::options_description generic("Generic options"); + return 0;]])], + ax_cv_boost_program_options=yes, ax_cv_boost_program_options=no) + AC_LANG_POP([C++]) + ]) + if test "$ax_cv_boost_program_options" = yes; then + AC_DEFINE(HAVE_BOOST_PROGRAM_OPTIONS,,[define if the Boost::PROGRAM_OPTIONS library is available]) + BOOSTLIBDIR=`echo $BOOST_LDFLAGS | sed -e 's/@<:@^\/@:>@*//'` + if test "x$ax_boost_user_program_options_lib" = "x"; then + for libextension in `ls $BOOSTLIBDIR/libboost_program_options*.so* 2>/dev/null | sed 's,.*/,,' | sed -e 's;^lib\(boost_program_options.*\)\.so.*$;\1;'` `ls $BOOSTLIBDIR/libboost_program_options*.a* 2>/dev/null | sed 's,.*/,,' | sed -e 's;^lib\(boost_program_options.*\)\.a*$;\1;'` ; do + ax_lib=${libextension} + AC_CHECK_LIB($ax_lib, exit, + [BOOST_PROGRAM_OPTIONS_LIB="-l$ax_lib"; AC_SUBST(BOOST_PROGRAM_OPTIONS_LIB) link_program_options="yes"; break], + [link_program_options="no"]) + done + if test "x$link_program_options" != "xyes"; then + for libextension in `ls $BOOSTLIBDIR/boost_program_options*.dll* 2>/dev/null | sed 's,.*/,,' | sed -e 's;^\(boost_program_options.*\)\.dll.*$;\1;'` `ls $BOOSTLIBDIR/boost_program_options*.a* 2>/dev/null | sed 's,.*/,,' | sed -e 's;^\(boost_program_options.*\)\.a*$;\1;'` ; do + ax_lib=${libextension} + AC_CHECK_LIB($ax_lib, exit, + [BOOST_PROGRAM_OPTIONS_LIB="-l$ax_lib"; AC_SUBST(BOOST_PROGRAM_OPTIONS_LIB) link_program_options="yes"; break], + [link_program_options="no"]) + done + fi + else + for ax_lib in $ax_boost_user_program_options_lib boost_program_options-$ax_boost_user_program_options_lib; do + AC_CHECK_LIB($ax_lib, main, + [BOOST_PROGRAM_OPTIONS_LIB="-l$ax_lib"; AC_SUBST(BOOST_PROGRAM_OPTIONS_LIB) link_program_options="yes"; break], + [link_program_options="no"]) + done + fi + if test "x$ax_lib" = "x"; then + AC_MSG_ERROR(Could not find a version of the library!) + fi + if test "x$link_program_options" != "xyes"; then + AC_MSG_ERROR([Could not link against [$ax_lib] !]) + fi + fi + CPPFLAGS="$CPPFLAGS_SAVED" + LDFLAGS="$LDFLAGS_SAVED" + fi +]) diff --git a/m4/ax_boost_system.m4 b/m4/ax_boost_system.m4 new file mode 100644 index 0000000..7fbf6d3 --- /dev/null +++ b/m4/ax_boost_system.m4 @@ -0,0 +1,120 @@ +# =========================================================================== +# http://www.gnu.org/software/autoconf-archive/ax_boost_system.html +# =========================================================================== +# +# SYNOPSIS +# +# AX_BOOST_SYSTEM +# +# DESCRIPTION +# +# Test for System library from the Boost C++ libraries. The macro requires +# a preceding call to AX_BOOST_BASE. Further documentation is available at +# <http://randspringer.de/boost/index.html>. +# +# This macro calls: +# +# AC_SUBST(BOOST_SYSTEM_LIB) +# +# And sets: +# +# HAVE_BOOST_SYSTEM +# +# LICENSE +# +# Copyright (c) 2008 Thomas Porschberg <thomas@randspringer.de> +# Copyright (c) 2008 Michael Tindal +# Copyright (c) 2008 Daniel Casimiro <dan.casimiro@gmail.com> +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty provided the copyright notice +# and this notice are preserved. This file is offered as-is, without any +# warranty. + +#serial 14 + +AC_DEFUN([AX_BOOST_SYSTEM], +[ + AC_ARG_WITH([boost-system], + AS_HELP_STRING([--with-boost-system@<:@=special-lib@:>@], + [use the System library from boost - it is possible to specify a certain library for the linker + e.g. --with-boost-system=boost_system-gcc-mt ]), + [ + if test "$withval" = "no"; then + want_boost="no" + elif test "$withval" = "yes"; then + want_boost="yes" + ax_boost_user_system_lib="" + else + want_boost="yes" + ax_boost_user_system_lib="$withval" + fi + ], + [want_boost="yes"] + ) + + if test "x$want_boost" = "xyes"; then + AC_REQUIRE([AC_PROG_CC]) + AC_REQUIRE([AC_CANONICAL_BUILD]) + CPPFLAGS_SAVED="$CPPFLAGS" + CPPFLAGS="$CPPFLAGS $BOOST_CPPFLAGS" + export CPPFLAGS + + LDFLAGS_SAVED="$LDFLAGS" + LDFLAGS="$LDFLAGS $BOOST_LDFLAGS" + export LDFLAGS + + AC_CACHE_CHECK(whether the Boost::System library is available, + ax_cv_boost_system, + [AC_LANG_PUSH([C++]) + CXXFLAGS_SAVE=$CXXFLAGS + + AC_COMPILE_IFELSE([AC_LANG_PROGRAM([[@%:@include <boost/system/error_code.hpp>]], + [[boost::system::system_category]])], + ax_cv_boost_system=yes, ax_cv_boost_system=no) + CXXFLAGS=$CXXFLAGS_SAVE + AC_LANG_POP([C++]) + ]) + if test "x$ax_cv_boost_system" = "xyes"; then + AC_SUBST(BOOST_CPPFLAGS) + + AC_DEFINE(HAVE_BOOST_SYSTEM,,[define if the Boost::System library is available]) + BOOSTLIBDIR=`echo $BOOST_LDFLAGS | sed -e 's/@<:@^\/@:>@*//'` + + LDFLAGS_SAVE=$LDFLAGS + if test "x$ax_boost_user_system_lib" = "x"; then + for libextension in `ls $BOOSTLIBDIR/libboost_system*.so* $BOOSTLIBDIR/libboost_system*.a* 2>/dev/null | sed 's,.*/,,' | sed -e 's;^lib\(boost_system.*\)\.so.*$;\1;' -e 's;^lib\(boost_system.*\)\.a*$;\1;'` ; do + ax_lib=${libextension} + AC_CHECK_LIB($ax_lib, exit, + [BOOST_SYSTEM_LIB="-l$ax_lib"; AC_SUBST(BOOST_SYSTEM_LIB) link_system="yes"; break], + [link_system="no"]) + done + if test "x$link_system" != "xyes"; then + for libextension in `ls $BOOSTLIBDIR/boost_system*.{dll,a}* 2>/dev/null | sed 's,.*/,,' | sed -e 's;^\(boost_system.*\)\.dll.*$;\1;' -e 's;^\(boost_system.*\)\.a*$;\1;'` ; do + ax_lib=${libextension} + AC_CHECK_LIB($ax_lib, exit, + [BOOST_SYSTEM_LIB="-l$ax_lib"; AC_SUBST(BOOST_SYSTEM_LIB) link_system="yes"; break], + [link_system="no"]) + done + fi + + else + for ax_lib in $ax_boost_user_system_lib boost_system-$ax_boost_user_system_lib; do + AC_CHECK_LIB($ax_lib, exit, + [BOOST_SYSTEM_LIB="-l$ax_lib"; AC_SUBST(BOOST_SYSTEM_LIB) link_system="yes"; break], + [link_system="no"]) + done + + fi + if test "x$ax_lib" = "x"; then + AC_MSG_ERROR(Could not find a version of the library!) + fi + if test "x$link_system" = "xno"; then + AC_MSG_ERROR(Could not link against $ax_lib !) + fi + fi + + CPPFLAGS="$CPPFLAGS_SAVED" + LDFLAGS="$LDFLAGS_SAVED" + fi +]) diff --git a/m4/ax_boost_unit_test_framework.m4 b/m4/ax_boost_unit_test_framework.m4 new file mode 100644 index 0000000..c8e823d --- /dev/null +++ b/m4/ax_boost_unit_test_framework.m4 @@ -0,0 +1,137 @@ +# ================================================================================ +# http://www.gnu.org/software/autoconf-archive/ax_boost_unit_test_framework.html +# ================================================================================ +# +# SYNOPSIS +# +# AX_BOOST_UNIT_TEST_FRAMEWORK +# +# DESCRIPTION +# +# Test for Unit_Test_Framework library from the Boost C++ libraries. The +# macro requires a preceding call to AX_BOOST_BASE. Further documentation +# is available at <http://randspringer.de/boost/index.html>. +# +# This macro calls: +# +# AC_SUBST(BOOST_UNIT_TEST_FRAMEWORK_LIB) +# +# And sets: +# +# HAVE_BOOST_UNIT_TEST_FRAMEWORK +# +# LICENSE +# +# Copyright (c) 2008 Thomas Porschberg <thomas@randspringer.de> +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty provided the copyright notice +# and this notice are preserved. This file is offered as-is, without any +# warranty. + +#serial 17 + +AC_DEFUN([AX_BOOST_UNIT_TEST_FRAMEWORK], +[ + AC_ARG_WITH([boost-unit-test-framework], + AS_HELP_STRING([--with-boost-unit-test-framework@<:@=special-lib@:>@], + [use the Unit_Test_Framework library from boost - it is possible to specify a certain library for the linker + e.g. --with-boost-unit-test-framework=boost_unit_test_framework-gcc ]), + [ + if test "$withval" = "no"; then + want_boost="no" + elif test "$withval" = "yes"; then + want_boost="yes" + ax_boost_user_unit_test_framework_lib="" + else + want_boost="yes" + ax_boost_user_unit_test_framework_lib="$withval" + fi + ], + [want_boost="yes"] + ) + + if test "x$want_boost" = "xyes"; then + AC_REQUIRE([AC_PROG_CC]) + CPPFLAGS_SAVED="$CPPFLAGS" + CPPFLAGS="$CPPFLAGS $BOOST_CPPFLAGS" + export CPPFLAGS + + LDFLAGS_SAVED="$LDFLAGS" + LDFLAGS="$LDFLAGS $BOOST_LDFLAGS" + export LDFLAGS + + AC_CACHE_CHECK(whether the Boost::Unit_Test_Framework library is available, + ax_cv_boost_unit_test_framework, + [AC_LANG_PUSH([C++]) + AC_COMPILE_IFELSE([AC_LANG_PROGRAM([[@%:@include <boost/test/unit_test.hpp>]], + [[using boost::unit_test::test_suite; + test_suite* test= BOOST_TEST_SUITE( "Unit test example 1" ); return 0;]])], + ax_cv_boost_unit_test_framework=yes, ax_cv_boost_unit_test_framework=no) + AC_LANG_POP([C++]) + ]) + if test "x$ax_cv_boost_unit_test_framework" = "xyes"; then + AC_DEFINE(HAVE_BOOST_UNIT_TEST_FRAMEWORK,,[define if the Boost::Unit_Test_Framework library is available]) + BOOSTLIBDIR=`echo $BOOST_LDFLAGS | sed -e 's/@<:@^\/@:>@*//'` + + if test "x$ax_boost_user_unit_test_framework_lib" = "x"; then + saved_ldflags="${LDFLAGS}" + for monitor_library in `ls $BOOSTLIBDIR/libboost_unit_test_framework*.so* $BOOSTLIBDIR/libboost_unit_test_framework*.a* 2>/dev/null` ; do + if test -r $monitor_library ; then + libextension=`echo $monitor_library | sed 's,.*/,,' | sed -e 's;^lib\(boost_unit_test_framework.*\)\.so.*$;\1;' -e 's;^lib\(boost_unit_test_framework.*\)\.a*$;\1;'` + ax_lib=${libextension} + link_unit_test_framework="yes" + else + link_unit_test_framework="no" + fi + + if test "x$link_unit_test_framework" = "xyes"; then + BOOST_UNIT_TEST_FRAMEWORK_LIB="-l$ax_lib" + AC_SUBST(BOOST_UNIT_TEST_FRAMEWORK_LIB) + break + fi + done + if test "x$link_unit_test_framework" != "xyes"; then + for libextension in `ls $BOOSTLIBDIR/boost_unit_test_framework*.{dll,a}* 2>/dev/null | sed 's,.*/,,' | sed -e 's;^\(boost_unit_test_framework.*\)\.dll.*$;\1;' -e 's;^\(boost_unit_test_framework.*\)\.a*$;\1;'` ; do + ax_lib=${libextension} + AC_CHECK_LIB($ax_lib, exit, + [BOOST_UNIT_TEST_FRAMEWORK_LIB="-l$ax_lib"; AC_SUBST(BOOST_UNIT_TEST_FRAMEWORK_LIB) link_unit_test_framework="yes"; break], + [link_unit_test_framework="no"]) + done + fi + else + link_unit_test_framework="no" + saved_ldflags="${LDFLAGS}" + for ax_lib in boost_unit_test_framework-$ax_boost_user_unit_test_framework_lib $ax_boost_user_unit_test_framework_lib ; do + if test "x$link_unit_test_framework" = "xyes"; then + break; + fi + for unittest_library in `ls $BOOSTLIBDIR/lib${ax_lib}.so* $BOOSTLIBDIR/lib${ax_lib}.a* 2>/dev/null` ; do + if test -r $unittest_library ; then + libextension=`echo $unittest_library | sed 's,.*/,,' | sed -e 's;^lib\(boost_unit_test_framework.*\)\.so.*$;\1;' -e 's;^lib\(boost_unit_test_framework.*\)\.a*$;\1;'` + ax_lib=${libextension} + link_unit_test_framework="yes" + else + link_unit_test_framework="no" + fi + + if test "x$link_unit_test_framework" = "xyes"; then + BOOST_UNIT_TEST_FRAMEWORK_LIB="-l$ax_lib" + AC_SUBST(BOOST_UNIT_TEST_FRAMEWORK_LIB) + break + fi + done + done + fi + if test "x$ax_lib" = "x"; then + AC_MSG_ERROR(Could not find a version of the library!) + fi + if test "x$link_unit_test_framework" != "xyes"; then + AC_MSG_ERROR(Could not link against $ax_lib !) + fi + fi + + CPPFLAGS="$CPPFLAGS_SAVED" + LDFLAGS="$LDFLAGS_SAVED" + fi +]) diff --git a/m4/ax_cxx_compile_stdcxx_0x.m4 b/m4/ax_cxx_compile_stdcxx_0x.m4 new file mode 100644 index 0000000..a4e556f --- /dev/null +++ b/m4/ax_cxx_compile_stdcxx_0x.m4 @@ -0,0 +1,107 @@ +# ============================================================================ +# http://www.gnu.org/software/autoconf-archive/ax_cxx_compile_stdcxx_0x.html +# ============================================================================ +# +# SYNOPSIS +# +# AX_CXX_COMPILE_STDCXX_0X +# +# DESCRIPTION +# +# Check for baseline language coverage in the compiler for the C++0x +# standard. +# +# LICENSE +# +# Copyright (c) 2008 Benjamin Kosnik <bkoz@redhat.com> +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty provided the copyright notice +# and this notice are preserved. This file is offered as-is, without any +# warranty. + +#serial 7 + +AU_ALIAS([AC_CXX_COMPILE_STDCXX_0X], [AX_CXX_COMPILE_STDCXX_0X]) +AC_DEFUN([AX_CXX_COMPILE_STDCXX_0X], [ + AC_CACHE_CHECK(if g++ supports C++0x features without additional flags, + ax_cv_cxx_compile_cxx0x_native, + [AC_LANG_SAVE + AC_LANG_CPLUSPLUS + AC_TRY_COMPILE([ + template <typename T> + struct check + { + static_assert(sizeof(int) <= sizeof(T), "not big enough"); + }; + + typedef check<check<bool>> right_angle_brackets; + + int a; + decltype(a) b; + + typedef check<int> check_type; + check_type c; + check_type&& cr = static_cast<check_type&&>(c);],, + ax_cv_cxx_compile_cxx0x_native=yes, ax_cv_cxx_compile_cxx0x_native=no) + AC_LANG_RESTORE + ]) + + AC_CACHE_CHECK(if g++ supports C++0x features with -std=c++0x, + ax_cv_cxx_compile_cxx0x_cxx, + [AC_LANG_SAVE + AC_LANG_CPLUSPLUS + ac_save_CXXFLAGS="$CXXFLAGS" + CXXFLAGS="$CXXFLAGS -std=c++0x" + AC_TRY_COMPILE([ + template <typename T> + struct check + { + static_assert(sizeof(int) <= sizeof(T), "not big enough"); + }; + + typedef check<check<bool>> right_angle_brackets; + + int a; + decltype(a) b; + + typedef check<int> check_type; + check_type c; + check_type&& cr = static_cast<check_type&&>(c);],, + ax_cv_cxx_compile_cxx0x_cxx=yes, ax_cv_cxx_compile_cxx0x_cxx=no) + CXXFLAGS="$ac_save_CXXFLAGS" + AC_LANG_RESTORE + ]) + + AC_CACHE_CHECK(if g++ supports C++0x features with -std=gnu++0x, + ax_cv_cxx_compile_cxx0x_gxx, + [AC_LANG_SAVE + AC_LANG_CPLUSPLUS + ac_save_CXXFLAGS="$CXXFLAGS" + CXXFLAGS="$CXXFLAGS -std=gnu++0x" + AC_TRY_COMPILE([ + template <typename T> + struct check + { + static_assert(sizeof(int) <= sizeof(T), "not big enough"); + }; + + typedef check<check<bool>> right_angle_brackets; + + int a; + decltype(a) b; + + typedef check<int> check_type; + check_type c; + check_type&& cr = static_cast<check_type&&>(c);],, + ax_cv_cxx_compile_cxx0x_gxx=yes, ax_cv_cxx_compile_cxx0x_gxx=no) + CXXFLAGS="$ac_save_CXXFLAGS" + AC_LANG_RESTORE + ]) + + if test "$ax_cv_cxx_compile_cxx0x_native" = yes || + test "$ax_cv_cxx_compile_cxx0x_cxx" = yes || + test "$ax_cv_cxx_compile_cxx0x_gxx" = yes; then + AC_DEFINE(HAVE_STDCXX_0X,,[Define if g++ supports C++0x features. ]) + fi +]) diff --git a/packaging/settingsd.changes b/packaging/settingsd.changes new file mode 100644 index 0000000..37b6d10 --- /dev/null +++ b/packaging/settingsd.changes @@ -0,0 +1,3 @@ +* Thu Oct 03 2013 Ossama Othman <ossama.othman@intel.com> 5c4d6b7 +- TIVI-1924: Initial commit of IVI settings daemon. + diff --git a/packaging/settingsd.manifest b/packaging/settingsd.manifest new file mode 100644 index 0000000..017d22d --- /dev/null +++ b/packaging/settingsd.manifest @@ -0,0 +1,5 @@ +<manifest> + <request> + <domain name="_"/> + </request> +</manifest> diff --git a/packaging/settingsd.service b/packaging/settingsd.service new file mode 100644 index 0000000..8fffad2 --- /dev/null +++ b/packaging/settingsd.service @@ -0,0 +1,11 @@ +[Unit] +Description=Tizen IVI Settings Daemon +Requires=connman.service +After=connman.service,weston.target + +[Service] +ExecStart=/usr/bin/settingsd +Restart=on-failure + +[Install] +WantedBy=weston.target diff --git a/packaging/settingsd.socket b/packaging/settingsd.socket new file mode 100644 index 0000000..8d07b26 --- /dev/null +++ b/packaging/settingsd.socket @@ -0,0 +1,10 @@ +[Unit] +Description=Tizen IVI Settings Daemon Activation Socket + +[Socket] +ListenStream=127.0.0.1:16000 + +# Only allow connections through the loopback network interface. +BindToDevice=lo + +ReusePort=true diff --git a/packaging/settingsd.spec b/packaging/settingsd.spec new file mode 100644 index 0000000..c3f0c32 --- /dev/null +++ b/packaging/settingsd.spec @@ -0,0 +1,93 @@ +Name: settingsd +Summary: Tizen IVI Settings Daemon +Version: 0.1 +Release: 1 +Group: Application Framework/Settings +License: LGPL-2.1 +URL: http://tizen.org/ +Source: %{name}-%{version}.tar.gz +Source1: settingsd.service +Source2: settingsd.socket +Source1001: %{name}.manifest +BuildRequires: pkgconfig(gio-2.0) +BuildRequires: pkgconfig(json-glib-1.0) +BuildRequires: pkgconfig(libwebsockets) +BuildRequires: doxygen +BuildRequires: boost-devel + +%define pkgincludedir %{_includedir}/%{name} +%define pkglibdir %{_libdir}/%{name} +%define _unitdir_user /usr/lib/systemd/user + + +%description +The settings daemon provides native backend support for settings +related operations initiated by the Tizen IVI Settings app. In +particular, it fills gaps in functionality required by the Settings +app that are not available in any of the Web APIs available in Tizen +IVI. + +Settingsd is comprised of a standalone binary as well as a library, +libsettings, that provides the interface settingsd plugin writers +must implement. + +%package devel +Summary: Plug-in library development package (headers, etc) +Group: Application Framework/Settings +Requires: %{name} = %{version} + +%description devel +The settings daemon provides native backend support for settings +related operations initiated by the Tizen IVI Settings app. In +particular, it fills gaps in functionality required by the Settings +app that are not available in any of the Web APIs available in Tizen +IVI. + +Settingsd is comprised of a standalone binary as well as a library, +libsettings, that provides the interface settingsd plugin writers +must implement. + + +%prep +%setup -q -n %{name}-%{version} +cp %{SOURCE1001} . + +%build +autoreconf --install --include=m4 +%configure +make %{?_smp_mflags} + +%install +%make_install + +rm %{buildroot}%{pkglibdir}/test_setting.so + +mkdir -p %{buildroot}%{_unitdir_user} +install -d %{buildroot}/%{_unitdir_user}/weston.target.wants +install -m 644 %{SOURCE1} %{buildroot}%{_unitdir_user}/settingsd.service +ln -sf ../settingsd.service %{buildroot}/%{_unitdir_user}/weston.target.wants/ + +%clean + +%post -p /sbin/ldconfig + +%postun -p /sbin/ldconfig + +%files +%manifest %{name}.manifest +%dir %{pkglibdir} +%doc AUTHORS README +%license COPYING COPYING.LESSER +%{_bindir}/settingsd +%{_libdir}/libsettings.so.* +%{pkglibdir}/*.so +%config %{_sysconfdir}/%{name}/* +%{_unitdir_user}/settingsd.service +%{_unitdir_user}/weston.target.wants/settingsd.service + +%files devel +%manifest %{name}.manifest +%{_libdir}/libsettings.so +%{pkgincludedir}/*.hpp + + diff --git a/plugins/Makefile.am b/plugins/Makefile.am new file mode 100644 index 0000000..8e03c1c --- /dev/null +++ b/plugins/Makefile.am @@ -0,0 +1,18 @@ +## Copyright 2013 Intel Corporation All Rights Reserved. +## +## This library is free software; you can redistribute it and/or +## modify it under the terms of the GNU Lesser General Public +## License as published by the Free Software Foundation; +## version 2.1 of the License. +## +## This library 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 +## Lesser General Public License for more details. +## +## You should have received a copy of the GNU Lesser General Public +## License along with this library; if not, write to the Free Software +## Foundation, Inc., 51 Franklin Street, Fifth Floor, +## Boston, MA 02110-1301 USA + +SUBDIRS = connman diff --git a/plugins/connman/Makefile.am b/plugins/connman/Makefile.am new file mode 100644 index 0000000..2f6b3b6 --- /dev/null +++ b/plugins/connman/Makefile.am @@ -0,0 +1,64 @@ +## Copyright 2013 Intel Corporation All Rights Reserved. +## +## This library is free software; you can redistribute it and/or +## modify it under the terms of the GNU Lesser General Public +## License as published by the Free Software Foundation; +## version 2.1 of the License. +## +## This library 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 +## Lesser General Public License for more details. +## +## You should have received a copy of the GNU Lesser General Public +## License along with this library; if not, write to the Free Software +## Foundation, Inc., 51 Franklin Street, Fifth Floor, +## Boston, MA 02110-1301 USA + + +pkglib_LTLIBRARIES = connman.la + +if SETTINGS_USE_GCC_SYMBOL_VISIBILITY + IVI_SETTINGS_PLUGIN_CXXFLAGS = -fvisibility=hidden -fvisibility-inlines-hidden +else + IVI_SETTINGS_PLUGIN_CXXFLAGS = +endif + +IVI_SETTINGS_PLUGIN_CPPFLAGS = \ + -DIVI_SETTINGS_CONNMAN_BUILDING_DLL \ + -I$(top_srcdir)/include + +IVI_SETTINGS_PLUGIN_LIBRARY = $(top_builddir)/lib/libsettings.la + +connman_la_SOURCES = \ + connman.cpp \ + connman_manager.cpp \ + service.cpp \ + technology.cpp \ + bluetooth.cpp \ + clock.cpp \ + ethernet.cpp \ + wifi.cpp \ + registration.cpp +connman_la_CXXFLAGS = \ + $(IVI_SETTINGS_PLUGIN_CXXFLAGS) \ + $(GIO_CFLAGS) \ + $(JSON_GLIB_CFLAGS) +connman_la_CPPFLAGS = $(IVI_SETTINGS_PLUGIN_CPPFLAGS) +connman_la_LIBADD = $(IVI_SETTINGS_PLUGIN_LIBRARY) +connman_la_LDFLAGS = -no-undefined \ + -module \ + -avoid-version \ + $(GIO_LIBS) \ + $(JSON_GLIB_LIBS) + +noinst_HEADERS = \ + connman_api.hpp \ + connman.hpp \ + connman_manager.hpp \ + service.hpp \ + technology.hpp \ + bluetooth.hpp \ + clock.hpp \ + ethernet.hpp \ + wifi.hpp diff --git a/plugins/connman/bluetooth.cpp b/plugins/connman/bluetooth.cpp new file mode 100644 index 0000000..576eb4e --- /dev/null +++ b/plugins/connman/bluetooth.cpp @@ -0,0 +1,66 @@ +/** + * @file bluetooth.cpp + * + * @brief Connman-based bluetooth settings. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#include "bluetooth.hpp" +#include <settingsd/response_callback.hpp> + +// ---------------------------------------------------------------------- + +namespace +{ + std::string const technology_name("bluetooth"); +} + +// ---------------------------------------------------------------------- + +ivi::settings::bluetooth::bluetooth() + : technology_(technology_name) +{ +} + +ivi::settings::bluetooth::~bluetooth() +{ +} + +std::string const & +ivi::settings::bluetooth::id() const +{ + return technology_name; +} + +void +ivi::settings::bluetooth::handle_request(std::string request, + response_callback response) +{ + technology_.handle_request(request, response); +} + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/plugins/connman/bluetooth.hpp b/plugins/connman/bluetooth.hpp new file mode 100644 index 0000000..31741c0 --- /dev/null +++ b/plugins/connman/bluetooth.hpp @@ -0,0 +1,96 @@ +/** + * @file bluetooth.hpp + * + * @brief Bluetooth settings plugin. + * + * Connman-based bluetooth settings plugin. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2012, 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + * + * @note This header is internal. Settings provider plugin implementors + * should write their own library/symbol export macros as + * needed. + */ + + +#ifndef IVI_SETTINGS_CONNMAN_BLUETOOTH_HPP +#define IVI_SETTINGS_CONNMAN_BLUETOOTH_HPP + +#include <settingsd/plugin.hpp> + +#include "technology.hpp" + + +namespace ivi +{ + namespace settings + { + /** + * @class bluetooth + * + * @brief Connman-based bluetooth settings. + * + * This class implements all connman-based bluetooth settings. + */ + class bluetooth : public plugin + { + public: + + /// Constructor. + bluetooth(); + + /// Destructor. + virtual ~bluetooth(); + + /** + * @name Settings Plugin API + * + * Interface defined by the @c ivi::settings::plugin abstract + * base class. + * + * @see settingsd/plugin.hpp + */ + //@{ + virtual std::string const & id() const; + virtual void handle_request(std::string request, + response_callback response); + //@} + + private: + + /// Underlying connman proxy. + technology technology_; + + }; + + } +} + + +#endif /* IVI_SETTINGS_CONNMAN_BLUETOOTH_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: + diff --git a/plugins/connman/clock.cpp b/plugins/connman/clock.cpp new file mode 100644 index 0000000..9ff91ea --- /dev/null +++ b/plugins/connman/clock.cpp @@ -0,0 +1,336 @@ +/** + * @file clock.cpp + * + * @brief Connman-based clock settings. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#include "clock.hpp" + +#include <settingsd/response_callback.hpp> +#include <settingsd/glib_traits.hpp> +#include <settingsd/json_glib_traits.hpp> +#include <settingsd/smart_ptr.hpp> + +#include <cstring> +#include <boost/lexical_cast.hpp> + + +ivi::settings::clock::clock() + : connman_("net.connman.Clock", "/") +{ +} + +ivi::settings::clock::~clock() +{ +} + +std::string const & +ivi::settings::clock::id() const +{ + static std::string const the_id("clock"); + + return the_id; +} + +void +ivi::settings::clock::handle_request(std::string request, + response_callback response) +{ + smart_ptr<JsonParser> const parser(json_parser_new()); + json_parser_load_from_data(parser.get(), request.c_str(), -1, nullptr); + + JsonReader * const reader = + json_reader_new(json_parser_get_root(parser.get())); + + smart_ptr<JsonReader> safe_reader(reader); + + char const * name = nullptr; + if (json_reader_read_member(reader, "name")) { + name = json_reader_get_string_value(reader); + } + json_reader_end_member(reader); + + if (name != nullptr) { + GError * error = nullptr; + bool success = false; + + if (strcmp(name, "time") == 0) + success = set_time(reader, response, error); + else if (strcmp(name, "time_updates") == 0) + success = set_updates("TimeUpdates", reader, response, error); + else if (strcmp(name, "timezone") == 0) + success = set_timezone(reader, response, error); + else if (strcmp(name, "timezone_updates") == 0) + success = set_updates("TimezoneUpdates", reader, response, error); + else if (strcmp(name, "is_time_updates_auto") == 0) + is_updates_auto("TimeUpdates", reader, response, error); + else if (strcmp(name, "is_timezone_updates_auto") == 0) + is_updates_auto("TimezoneUpdates", reader, response, error); + else { + response.send_error( + "Unrecognized " + id() + " request name: " + name); + } + + smart_ptr<GError> safe_error(error); + + if (success) { + + // Nothing to add to successful response. + response.send_response( + [](JsonBuilder * /* builder */) {}); + + } else if (error != nullptr) { + response.send_error( + std::string("Unable to set ") + name + ": " + error->message); + } + + // If success is false and error == nullptr a succesful response + // was sent by one of the functions above, e.g. is_update_auto(). + + } else { + response.send_error( + "Malformed " + id() + " request: \"name\" is missing."); + } +} + +bool +ivi::settings::clock::set_time(JsonReader * reader, + response_callback response, + GError *& error) +{ + int64_t time; + if (json_reader_read_member(reader, "value")) { + /** + * @bug @c json_read_get_int_value() returns a signed 64 bit + * integer. However, the connman clock API expects an + * unsigned 64 bit integer. This means we cannot set time + * values before the Unix epoch (< 0) or greater than + * (2^63)-1, i.e the largest signed 64 bit integer. + */ + time = json_reader_get_int_value(reader); + } + + json_reader_end_member(reader); + + bool success = false; + + if (time >= 0) { + // Note that the connman clock API expects an unsigned 64 bit + // integer containing seconds since the Unix epoch. We cast the + // positive int64_t value to an uint64_t value. There is no + // chance of overflow in this case. + success = + set_property("Time", + g_variant_new_uint64(static_cast<uint64_t>(time)), + response, + error); + } else { + response.send_error("Time value is earlier than epoch (negative): " + + boost::lexical_cast<std::string>(time)); + } + + return success; +} + +bool +ivi::settings::clock::set_timezone(JsonReader * reader, + response_callback response, + GError *& error) +{ + bool success = false; + + if (json_reader_read_member(reader, "value")) { + char const * const timezone = json_reader_get_string_value(reader); + success = this->set_property("Timezone", + g_variant_new_string(timezone), + response, + error); + } + + json_reader_end_member(reader); + + return success; +} + +bool +ivi::settings::clock::set_updates(char const * name, + JsonReader * reader, + response_callback response, + GError *& error) +{ + bool success = false; + + char const * updates = nullptr; + if (json_reader_read_member(reader, "value")) { + updates = json_reader_get_string_value(reader); + } + json_reader_end_member(reader); + + if (updates == nullptr + || (strcmp(updates, "manual") != 0 + && strcmp(updates, "auto") != 0)) { + response.send_error(id() + + ": updates value not \"manual\" " + "or \"auto\": " + + (updates == nullptr + ? "<invalid_string>" + : updates)); + } else { + smart_ptr<GVariant> const current_value(get_property(name, error)); + + if (current_value != nullptr) { + char const * value = + g_variant_get_string(current_value.get(), nullptr); + + if (strcmp(value, updates) == 0) { + // Already set. Just return success, otherwise we'll timeout + // waiting for a PropertyChanged signal that'll never come. + return true; + } + } + + success = set_property(name, + g_variant_new_string(updates), + response, + error); + } + + return success; +} + +void +ivi::settings::clock::is_updates_auto(char const * name, + JsonReader * reader, + response_callback response, + GError *& error) +{ + bool null = false; + if (json_reader_read_member(reader, "value")) { + null = json_reader_get_null_value(reader); + } + json_reader_end_member(reader); + + if (!null) { + response.send_error(std::string(name) + " query parameter is not null."); + return; + } + + smart_ptr<GVariant> const current_value(get_property(name, error)); + + if (current_value != nullptr) { + char const * value = + g_variant_get_string(current_value.get(), nullptr); + + bool const is_auto = (strcmp(value, "auto") == 0); + + response.send_response( + [is_auto](JsonBuilder * builder) + { + json_builder_set_member_name(builder, "value"); + json_builder_add_boolean_value(builder, is_auto); + }); + } +} + +bool +ivi::settings::clock::set_property(char const * name, + GVariant * value, + response_callback response, + GError *& error) +{ + bool success = false; + + // Get notified when the clock property has changed. + auto property_promise = connman_.get_property_changed_promise(name); + auto property_future = property_promise->get_future(); + + smart_ptr<GVariant> const ret( + connman_.set_property(name, value, error)); + + if (ret != nullptr) { + static int const timeout = 5000; // milliseconds + + // Block until the clock property has changed.. + std::future_status const status = + property_future.wait_for(std::chrono::milliseconds(timeout)); + + if (status == std::future_status::ready) { + smart_ptr<GVariant> const value(property_future.get()); + success = true; + } else { + response.send_error( + std::string("Wait for clock property \"") + + name + "\" set failed: " + + (status == std::future_status::timeout + ? "timeout" + : "deferred")); + } + } + + return success; +} + +GVariant * +ivi::settings::clock::get_property(char const * property, + GError *& error) const +{ + constexpr gint const timeout = 5000; // milliseconds + + smart_ptr<GVariant> const dictionary( + g_dbus_proxy_call_sync(connman_.proxy(), + "GetProperties", + nullptr, // No parameters + G_DBUS_CALL_FLAGS_NONE, + timeout, + nullptr, // Not cancellable + &error)); + + smart_ptr<GVariant> value; + + if (dictionary != nullptr) { + GVariantIter * i = nullptr; + g_variant_get(dictionary.get(), "(a{sv})", &i); + smart_ptr<GVariantIter> const iter(i); + + gchar * pname = nullptr; + GVariant * pvalue = nullptr; + + while (g_variant_iter_next(i, "{sv}", &pname, &pvalue)) { + smart_ptr<gchar> const name(pname); + value.reset(pvalue); + + // Check if this is the property we want. + if (strcmp(name.get(), property) == 0) + break; + } + } + + return value.release(); +} + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/plugins/connman/clock.hpp b/plugins/connman/clock.hpp new file mode 100644 index 0000000..e902af4 --- /dev/null +++ b/plugins/connman/clock.hpp @@ -0,0 +1,136 @@ +/** + * @file clock.hpp + * + * @brief Clock settings plugin. + * + * Connman-based clock settings plugin. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2012, 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + * + * @note This header is internal. Settings provider plugin implementors + * should write their own library/symbol export macros as + * needed. + */ + + +#ifndef IVI_SETTINGS_CONNMAN_CLOCK_HPP +#define IVI_SETTINGS_CONNMAN_CLOCK_HPP + +#include "connman.hpp" +#include <settingsd/plugin.hpp> + +#include <json-glib/json-glib.h> + + +namespace ivi +{ + namespace settings + { + class response_callback; + + /** + * @class clock + * + * @brief Connman-based clock settings. + * + * This class implements all connman-based clock settings. + */ + class clock : public plugin + { + public: + + /// Constructor. + clock(); + + /// Destructor. + virtual ~clock(); + + /** + * @name Settings Plugin API + * + * Interface defined by the @c ivi::settings::plugin abstract + * base class. + * + * @see settingsd/plugin.hpp + */ + //@{ + virtual std::string const & id() const; + virtual void handle_request(std::string request, + response_callback response); + //@} + + private: + + /// Set the time. + bool set_time(JsonReader * reader, + response_callback response, + GError *& error); + + /// Set the timezone. + bool set_timezone(JsonReader * reader, + response_callback response, + GError *& error); + + /// Set time or timezone updates to manual or auto. + bool set_updates(char const * name, + JsonReader * reader, + response_callback response, + GError *& error); + + /** + * Check if the TimeUpdates or TimezoneUpdate property is set + * to "auto". + */ + void is_updates_auto(char const * name, + JsonReader * reader, + response_callback response, + GError *& error); + + /// Set the clock property. + bool set_property(char const * name, + GVariant * value, + response_callback response, + GError *& error); + + /// Get the clock property. + GVariant * get_property(char const * name, + GError *& error) const; + + private: + + /// Underlying connman proxy. + connman connman_; + + }; + + } +} + + +#endif /* IVI_SETTINGS_CONNMAN_CLOCK_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: + diff --git a/plugins/connman/connman.cpp b/plugins/connman/connman.cpp new file mode 100644 index 0000000..a3864c8 --- /dev/null +++ b/plugins/connman/connman.cpp @@ -0,0 +1,197 @@ +/** + * @file connman.cpp + * + * @brief Connman-based settings plugin. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#include "connman.hpp" + +#include <settingsd/reverse_lock.hpp> + +#include <cstring> +#include <string> +#include <stdexcept> + + +namespace +{ + void + on_property_changed(GDBusConnection * /* connection */, + char const * /* sender_name */, + char const * /* object_path */, + char const * /* interface_name */, + char const * /* signal_name */, + GVariant * parameters, + gpointer user_data) + { + // Notify callers about the scan results. + typedef ivi::settings::connman::user_data user_data_type; + + user_data_type * const data = static_cast<user_data_type *>(user_data); + + std::lock_guard<std::mutex> lock(data->mutex); + auto const end = data->promises.end(); + for (auto i = data->promises.begin(); i != end; ) { + gchar * pname = nullptr; + GVariant * pvalue = nullptr; + + g_variant_get(parameters, "(sv)", &pname, &pvalue); + + using namespace ivi::settings; + + smart_ptr<gchar> name(pname); + smart_ptr<GVariant> value(pvalue); + + auto & p = *i; + + // Set the value in the promise if the desired property name + // matches. + if (strcmp(p.first, pname) == 0) { + { + // Release the mutex during the promise::set_value() + // call/notification so that we don't unnecessarily block + // threads attempting to get a property_changed promise. + typedef ivi::settings::reverse_lock<std::mutex> reverse_lock; + reverse_lock reverse(data->mutex); + + std::lock_guard<reverse_lock> kcol(reverse); + + p.second->set_value(std::move(value)); + } + + // Done with the pointer to the promise. Remove it from the + // list now since we already have an iterator to it. + i = data->promises.erase(i); + } else { + // Nothing to erase. Advance to the next list element. + ++i; + } + } + } +} + +// --------------------------------------------------------------- + +ivi::settings::connman::connman(char const * interface, + char const * path) + : proxy_(nullptr) + , mutex_() + , promises_() + , data_(mutex_, promises_) + , subscription_id_(0) +{ + static char const name[] = "net.connman"; // Service + + GError * error = nullptr; + + proxy_ = + g_dbus_proxy_new_for_bus_sync (G_BUS_TYPE_SYSTEM, + G_DBUS_PROXY_FLAGS_NONE, + nullptr, // GDBusInterfaceInfo + name, + path, + interface, + nullptr, // GCancellable + &error); + + smart_ptr<GError> safe_error(error); + + if (proxy_ == nullptr) { + g_printerr("Unable to create D-Bus proxy for (\"%s\", \"%s\"): %s\n", + interface, + path, + error->message); + + throw std::runtime_error(error->message); + } + + // Listen for changes to properties. + subscription_id_ = + g_dbus_connection_signal_subscribe( + g_dbus_proxy_get_connection(G_DBUS_PROXY(proxy_)), + nullptr, + interface, + "PropertyChanged", + path, + nullptr, + G_DBUS_SIGNAL_FLAGS_NONE, + on_property_changed, + &data_, + nullptr); +} + +ivi::settings::connman::~connman() +{ + if (proxy_ != nullptr) { + g_dbus_connection_signal_unsubscribe( + g_dbus_proxy_get_connection(G_DBUS_PROXY(proxy_)), + subscription_id_); + + g_object_unref(proxy_); + } +} + +GVariant * +ivi::settings::connman::set_property(char const * property, + GVariant * value, + GError *& error) +{ + static gint const timeout = 5000; // milliseconds + + return g_dbus_proxy_call_sync(proxy_, + "SetProperty", // Method name + g_variant_new("(sv)", + property, + value), + G_DBUS_CALL_FLAGS_NONE, + timeout, + nullptr, // Not cancellable + &error); +} + +ivi::settings::connman::shared_promise_type +ivi::settings::connman::get_property_changed_promise( + char const * property) +{ + // This promise must exist long enough for the value to retrieved + // from the future. Use a shared_ptr<> to make that possible. + shared_promise_type promise = std::make_shared<promise_type>(); + + { + std::lock_guard<std::mutex> lock(mutex_); + + // Add a new std::promise to the promises list. The promise will + // only be used once, and will be removed once its value has been + // set. + promises_.push_back(std::make_pair(property, promise)); + } + + return promise; +} + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/plugins/connman/connman.hpp b/plugins/connman/connman.hpp new file mode 100644 index 0000000..fa51caa --- /dev/null +++ b/plugins/connman/connman.hpp @@ -0,0 +1,198 @@ +/** + * @file connman.hpp + * + * @brief Connman-based settings plugin header. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + + +#ifndef IVI_SETTINGS_CONNMAN_HPP +#define IVI_SETTINGS_CONNMAN_HPP + +#include <settingsd/glib_traits.hpp> +#include <settingsd/smart_ptr.hpp> + +#include <gio/gio.h> + +#include <future> +#include <utility> +#include <list> +#include <memory> + + +namespace ivi +{ + namespace settings + { + /** + * @class connman + * + * @brief Common connman-based settings functionality. + * + * This class implements functionality common to all connman-based + * settings, such as bluetooth, wifi, date/time, etc. + */ + class connman + { + public: + + /** + * Constructor. + * + * @param[in] interface Connman D-Bus interface. + * @param[in] path Connman D-Bus object path. + */ + connman(char const * interface, + char const * path); + + /// Destructor. + ~connman(); + + /// The type held by the @c future containing the async result. + typedef smart_ptr<GVariant> future_value_type; + + /// The @c future type returned by the @c promise. + typedef std::future<future_value_type> future_type; + + /// The @c promise that provides the async result. + typedef std::promise<future_value_type> promise_type; + + /** + * Smart pointer to the @c promise that provides the async + * result. + */ + typedef std::shared_ptr<promise_type> shared_promise_type; + + /** + * Property Name/value pair type held by the @c future + * containing the async result. Both values will be populated + * when retrieving the value from the @c PropertyChanged + * signal. + * + * @note The property name is meant for internal use. + */ + typedef std::pair<char const *, + shared_promise_type> promise_value_type; + + /// List type for promises to be updated with async result. + typedef std::list<promise_value_type> promise_list_type; + + /** + * Set @a property to given @a value on the underlying connman + * object. + * + * @param[in] property The name of the property to be set. + * @param[in] value The property value to be set. + * @param[inout] error The error object containing information + * on a failed connman @c SetProperty method + * call. + * + * @returns @c nullptr on a failed call to the connman + * @c SetProperty method. + */ + GVariant * set_property(char const * property, + GVariant * value, + GError *& error); + + /** + * Get a promise that will contain the changed connman property + * when it becomes available. The user must obtain the value + * from the corresponding future object. + */ + shared_promise_type get_property_changed_promise( + char const * property); + + /// Get pointer to underlying GDBusProxy. + GDBusProxy * proxy() const { return proxy_; } + + /// Convenience function to get D-Bus interface name. + char const * + interface_name() const + { + return g_dbus_proxy_get_interface_name(proxy_); + } + + /// Convenience function to get D-Bus object path. + char const * + object_path() const + { + return g_dbus_proxy_get_object_path(proxy_); + } + + /** + * @struct user_data + * + * @brief Struct passed to @c ServicesChanged signal handler. + */ + struct user_data + { + /// Constructor. + user_data(std::mutex & m, promise_list_type & p) + : mutex(m) + , promises(p) + { + } + + /** + * References to mutex used to synchronize access to the list + * of promises. + */ + std::mutex & mutex; + + /// List of promises to be updated with the changed services. + promise_list_type & promises; + }; + + private: + + /// The proxy used to access the Connman D-Bus API. + GDBusProxy * proxy_; + + /// Mutex used to synchronize access to the promises list. + std::mutex mutex_; + + /** + * List of promises that will be updated with the + * PropertyChanged signal results. + */ + promise_list_type promises_; + + /// User data passed to @c PropertyChanged signal handler. + user_data data_; + + /// PropertyChanged signal subscription ID. + guint subscription_id_; + + }; + + } +} + + +#endif /* IVI_SETTINGS_CONNMAN_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/plugins/connman/connman_api.hpp b/plugins/connman/connman_api.hpp new file mode 100644 index 0000000..232fb56 --- /dev/null +++ b/plugins/connman/connman_api.hpp @@ -0,0 +1,66 @@ +/** + * @file connman_api.hpp + * + * @brief @c Connman-based settings plugin export macros. + * + * The IVI connman settings plugin uses these macros to + * export the settings plugin API from the plugin as needed. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + + +#ifndef IVI_SETTINGS_CONNMAN_API_HPP +#define IVI_SETTINGS_CONNMAN_API_HPP + +# if defined _WIN32 || defined __CYGWIN__ +# ifdef IVI_SETTINGS_CONNMAN_BUILDING_DLL +# ifdef __GNUC__ +# define IVI_SETTINGS_CONNMAN_API __attribute__ ((dllexport)) +# else +# define IVI_SETTINGS_CONNMAN_API __declspec(dllexport) +# endif +# else +# ifdef __GNUC__ +# define IVI_SETTINGS_CONNMAN_API __attribute__ ((dllimport)) +# else +# define IVI_SETTINGS_CONNMAN_API __declspec(dllimport) +# endif +# endif +# define IVI_SETTINGS_CONNMAN_LOCAL +# else +# if __GNUC__ >= 4 +# define IVI_SETTINGS_CONNMAN_API __attribute__ ((visibility ("default"))) +# define IVI_SETTINGS_CONNMAN_LOCAL __attribute__ ((visibility ("hidden"))) +# else +# define IVI_SETTINGS_CONNMAN_API +# define IVI_SETTINGS_CONNMAN_LOCAL +# endif +# endif + +#endif /* IVI_SETTINGS_CONNMAN_API_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/plugins/connman/connman_manager.cpp b/plugins/connman/connman_manager.cpp new file mode 100644 index 0000000..0be40e8 --- /dev/null +++ b/plugins/connman/connman_manager.cpp @@ -0,0 +1,228 @@ +/** + * @file connman_manager.cpp + * + * @brief Connman_Manager-based settings plugin. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#include "connman_manager.hpp" + +#include <settingsd/json_glib_traits.hpp> +#include <settingsd/reverse_lock.hpp> + +#include <cstring> + + +namespace +{ + void + on_services_changed(GDBusConnection * /* connection */, + char const * /* sender_name */, + char const * /* object_path */, + char const * /* interface_name */, + char const * /* signal_name */, + GVariant * parameters, + gpointer user_data) + { + gsize const num_params = g_variant_n_children(parameters); + if (num_params != 2) { + // We should never get here! + g_printerr("Number of ServicesChanged signal parameters " + "is not 2: %" G_GSIZE_FORMAT "\n", + num_params); + + return; + } + + using namespace ivi::settings; + + // Changed services are found in the first ServicesChanged + // argument. + smart_ptr<GVariant> const changed_services( + g_variant_get_child_value(parameters, 0)); + + // Serialize the changed services into a JSON tree. This will be + // an array of [object, dict], where "object" is the D-Bus object + // path, and "dict" is a dictionary of object-specific + // properties. + smart_ptr<JsonNode> services( + json_gvariant_serialize(changed_services.get())); + + // Notify callers about the scan results. + typedef connman_manager::user_data user_data_type; + + user_data_type * const p = static_cast<user_data_type *>(user_data); + connman_manager::promise_list_type & promises = p->promises; + + // Synchronize access to the promises list. + std::lock_guard<std::mutex> lock(p->mutex); + + // Note that the end() iterator must be retrieved during each loop + // iteration in case another thread caused another promise to be + // added to the list when the lock was temporarily unlocked during + // the promise::set_value() call below. + for (auto i = promises.begin(); i != promises.end(); ) { + auto & promise = *i; + + { + // Release the mutex during the promise::set_value() + // call/notification so that we don't unnecessarily block + // threads attempting to get a services_changed promise. + typedef ivi::settings::reverse_lock<std::mutex> reverse_lock; + reverse_lock reverse(p->mutex); + + std::lock_guard<reverse_lock> kcol(reverse); + + // Thread that owns the corresponding future must transfer + // ownership of the JsonNode to something that will release + // the underlying JsonNode, e.g. a JsonBuilder via + // json_builder_add_value() or another smart_ptr<JsonNode>. + promise->set_value(std::move(services)); + } + + // Done with the pointer to the promise. Remove it from the + // list now since we already have an iterator to it. + i = promises.erase(i); + } + } + +} + +// --------------------------------------------------------------- + +ivi::settings::connman_manager::connman_manager() + : connman_("net.connman.Manager", // Interface + "/") // Object path + , mutex_() + , promises_() + , data_(mutex_, promises_) + , subscription_id_( + g_dbus_connection_signal_subscribe( + g_dbus_proxy_get_connection(G_DBUS_PROXY(connman_.proxy())), + nullptr, + connman_.interface_name(), + "ServicesChanged", + connman_.object_path(), + nullptr, + G_DBUS_SIGNAL_FLAGS_NONE, + on_services_changed, + &data_, + nullptr)) +{ +} + +ivi::settings::connman_manager::~connman_manager() +{ + g_dbus_connection_signal_unsubscribe( + g_dbus_proxy_get_connection(G_DBUS_PROXY(connman_.proxy())), + subscription_id_); +} + +GVariant * +ivi::settings::connman_manager::get_properties( + std::string const & technology, + GError *& error) const +{ + constexpr gint const timeout = 5000; // milliseconds + + smart_ptr<GVariant> const dictionary( + g_dbus_proxy_call_sync(connman_.proxy(), + "GetTechnologies", + nullptr, // No parameters + G_DBUS_CALL_FLAGS_NONE, + timeout, + nullptr, // Not cancellable + &error)); + + if (dictionary != nullptr) { + GVariantIter * i = nullptr; + g_variant_get(dictionary.get(), "(a(oa{sv}))", &i); + smart_ptr<GVariantIter> const safe_i(i); + + for (smart_ptr<GVariant> child(g_variant_iter_next_value(i)); + child != nullptr; + child.reset(g_variant_iter_next_value(i))) { + + // The object path is the first tuple element. + smart_ptr<GVariant> const tmp( + g_variant_get_child_value(child.get(), 0)); + + char const * object = + g_variant_get_string(tmp.get(), nullptr); + + // The technology is found at end the object path, + // e.g. "/net/connman/technology/wifi" for the wifi. + char const * tech = strrchr(object, '/'); + + if (tech != nullptr) { + ++tech; // Skip the found '/'. + + if (technology == tech) { + // The property dictionary is the second tuple element. + return g_variant_get_child_value(child.get(), 1); + } + } + } + } + + return nullptr; +} + +GVariant * +ivi::settings::connman_manager::get_services(GError *& error) const +{ + constexpr gint const timeout = 5000; // milliseconds + + return g_dbus_proxy_call_sync(connman_.proxy(), + "GetServices", + nullptr, // No parameters + G_DBUS_CALL_FLAGS_NONE, + timeout, + nullptr, // Not cancellable + &error); +} + +ivi::settings::connman_manager::shared_promise_type +ivi::settings::connman_manager::get_services_changed_promise() +{ + // This promise must exist long enough for the value to retrieved + // from the future. Use a shared_ptr<> to make that possible. + shared_promise_type p = std::make_shared<promise_type>(); + + { + std::lock_guard<std::mutex> lock(mutex_); + + // Add a new std::promise to the promises list. The promise will + // only be used once, and will be removed once its value has been + // set. + promises_.push_back(p); + } + + return p; +} + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/plugins/connman/connman_manager.hpp b/plugins/connman/connman_manager.hpp new file mode 100644 index 0000000..352b9fe --- /dev/null +++ b/plugins/connman/connman_manager.hpp @@ -0,0 +1,175 @@ +/** + * @file connman_manager.hpp + * + * @brief Connman connman_manager-based settings plugin header. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#ifndef IVI_SETTINGS_CONNMAN_MANAGER_HPP +#define IVI_SETTINGS_CONNMAN_MANAGER_HPP + +#include "connman.hpp" + +#include <settingsd/glib_traits.hpp> +#include <settingsd/smart_ptr.hpp> + +#include <gio/gio.h> +#include <json-glib/json-glib.h> + +#include <future> +#include <list> +#include <memory> + + +namespace ivi +{ + namespace settings + { + /** + * @class connman_manager + * + * @brief Common connman-based settings functionality. + * + * This class implements functionality common to all connman-based + * settings, such as bluetooth, wifi, date/time, etc. + */ + class connman_manager + { + public: + + /// Constructor. + connman_manager(); + + /// Destructor. + ~connman_manager(); + + /** + * Get the properties for a specific technology. + * + * @param[in] technology Connman technology for which properties + * are being retrieved. + * @param[inout] error Glib error object that contains + * additional error information if + * non-null if the call completes. + * + * @return @c GVariant containing a dictionary of properties + * specific to @a technology. + */ + GVariant * get_properties(std::string const & technology, + GError *& error) const; + + /** + * Get connman services and their properties. + * + * @param[inout] error Glib error object that contains + * additional error information if + * non-null if the call completes. + * + * @return @c GVariant containing a dictionary services and + * corresponding properties. + */ + GVariant * get_services(GError *& error) const; + + /// The type held by the @c future containing the async result. + typedef smart_ptr<JsonNode> future_value_type; + + /// The @c future type returned by the @c promise. + typedef std::future<future_value_type> future_type; + + /// The @c promise that provides the async result. + typedef std::promise<future_value_type> promise_type; + + /** + * Smart pointer to the @c promise that provides the async + * result. + */ + typedef std::shared_ptr<promise_type> shared_promise_type; + + /// List type for promises to be updated with async result. + typedef std::list<shared_promise_type> promise_list_type; + + /** + * Get a promise that will contain changed connman services when + * they become available. The user must obtain the value from + * the corresponding future object and release the @c JsonNode* + * value contained within that future with @c json_node_free(). + */ + shared_promise_type get_services_changed_promise(); + + /** + * @struct user_data + * + * @brief Struct passed to @c ServicesChanged signal handler. + */ + struct user_data + { + /// Constructor. + user_data(std::mutex & m, promise_list_type & p) + : mutex(m) + , promises(p) + { + } + + /** + * References to mutex used to synchronize access to the list + * of promises. + */ + std::mutex & mutex; + + /// List of promises to be updated with the changed services. + promise_list_type & promises; + }; + + private: + + /// The proxy used to access the connman Manager D-Bus API. + connman connman_; + + /// Mutex used to synchronize access to the promises list. + std::mutex mutex_; + + /** + * List of promises that will be updated with the + * ServicesChanged signal results. + */ + promise_list_type promises_; + + /// User data passed to @c ServicesChanged signal handler. + user_data data_; + + /// ServicesChanged signal subscription ID. + guint const subscription_id_; + + }; + + } +} + + +#endif /* IVI_SETTINGS_CONNMAN_MANAGER_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/plugins/connman/ethernet.cpp b/plugins/connman/ethernet.cpp new file mode 100644 index 0000000..3e8699c --- /dev/null +++ b/plugins/connman/ethernet.cpp @@ -0,0 +1,66 @@ +/** + * @file ethernet.cpp + * + * @brief Connman-based ethernet settings. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#include "ethernet.hpp" +#include <settingsd/response_callback.hpp> + +// ---------------------------------------------------------------------- + +namespace +{ + std::string const technology_name("ethernet"); +} + +// ---------------------------------------------------------------------- + +ivi::settings::ethernet::ethernet() + : technology_(technology_name) +{ +} + +ivi::settings::ethernet::~ethernet() +{ +} + +std::string const & +ivi::settings::ethernet::id() const +{ + return technology_name; +} + +void +ivi::settings::ethernet::handle_request(std::string request, + response_callback response) +{ + technology_.handle_request(request, response); +} + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/plugins/connman/ethernet.hpp b/plugins/connman/ethernet.hpp new file mode 100644 index 0000000..65bf7fe --- /dev/null +++ b/plugins/connman/ethernet.hpp @@ -0,0 +1,96 @@ +/** + * @file ethernet.hpp + * + * @brief Ethernet settings plugin. + * + * Connman-based ethernet settings plugin. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2012, 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + * + * @note This header is internal. Settings provider plugin implementors + * should write their own library/symbol export macros as + * needed. + */ + + +#ifndef IVI_SETTINGS_CONNMAN_ETHERNET_HPP +#define IVI_SETTINGS_CONNMAN_ETHERNET_HPP + +#include <settingsd/plugin.hpp> + +#include "technology.hpp" + + +namespace ivi +{ + namespace settings + { + /** + * @class ethernet + * + * @brief Connman-based ethernet settings. + * + * This class implements all connman-based ethernet settings. + */ + class ethernet : public plugin + { + public: + + /// Constructor. + ethernet(); + + /// Destructor. + virtual ~ethernet(); + + /** + * @name Settings Plugin API + * + * Interface defined by the @c ivi::settings::plugin abstract + * base class. + * + * @see settingsd/plugin.hpp + */ + //@{ + virtual std::string const & id() const; + virtual void handle_request(std::string request, + response_callback response); + //@} + + private: + + /// Underlying connman proxy. + technology technology_; + + }; + + } +} + + +#endif /* IVI_SETTINGS_CONNMAN_ETHERNET_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: + diff --git a/plugins/connman/registration.cpp b/plugins/connman/registration.cpp new file mode 100644 index 0000000..2719f3d --- /dev/null +++ b/plugins/connman/registration.cpp @@ -0,0 +1,65 @@ +/** + * @file registration.cpp + * + * @brief Connman-based settings plugin registration. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#include "connman_api.hpp" +#include "bluetooth.hpp" +#include "clock.hpp" +#include "ethernet.hpp" +#include "wifi.hpp" + +#include <settingsd/registrar.hpp> + +#include <memory> + + +/// Plugin factory/registration function. +extern "C" IVI_SETTINGS_CONNMAN_API bool +register_settings(ivi::settings::registrar & r) +{ + std::unique_ptr<ivi::settings::plugin> bt( + new ivi::settings::bluetooth); + + std::unique_ptr<ivi::settings::plugin> clk( + new ivi::settings::clock); + + std::unique_ptr<ivi::settings::plugin> eth( + new ivi::settings::ethernet); + + std::unique_ptr<ivi::settings::plugin> wifi( + new ivi::settings::wifi); + + return + r.register_setting(std::move(bt)) + && r.register_setting(std::move(clk)) + && r.register_setting(std::move(eth)) + && r.register_setting(std::move(wifi)); +} + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/plugins/connman/service.cpp b/plugins/connman/service.cpp new file mode 100644 index 0000000..ecf267d --- /dev/null +++ b/plugins/connman/service.cpp @@ -0,0 +1,87 @@ +/** + * @file service.cpp + * + * @brief Connman service request handling. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#include "service.hpp" + +#include <settingsd/glib_traits.hpp> +#include <settingsd/smart_ptr.hpp> +#include <settingsd/response_callback.hpp> + +#include <chrono> + + +ivi::settings::service::service(std::string service_path) + : connman_("net.connman.Service", // Interface + service_path.c_str()) // Object path +{ +} + +void +ivi::settings::service::connect(response_callback response) +{ + call_method("Connect", response); +} + +void +ivi::settings::service::disconnect(response_callback response) +{ + call_method("Disconnect", response); +} + +void +ivi::settings::service::call_method(char const * name, + response_callback response) +{ + constexpr gint const timeout = 10000; // milliseconds + GError * error = nullptr; + + smart_ptr<GVariant> const ret( + g_dbus_proxy_call_sync(connman_.proxy(), + name, // "Connect", "Disconect", ... + nullptr, // No parameters + G_DBUS_CALL_FLAGS_NONE, + timeout, + nullptr, // Not cancellable + &error)); + + smart_ptr<GError> safe_error; + + if (ret != nullptr) { + // Nothing to add to successful response. + response.send_response( + [](JsonBuilder * /* builder */) {}); + + } else if (error != nullptr) { + response.send_error(std::string(name) + " failed: " + error->message); + } +} + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/plugins/connman/service.hpp b/plugins/connman/service.hpp new file mode 100644 index 0000000..a10268e --- /dev/null +++ b/plugins/connman/service.hpp @@ -0,0 +1,97 @@ +/** + * @file service.hpp + * + * @brief Connman service request handling. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#ifndef IVI_SETTINGS_CONNMAN_SERVICE_HPP +#define IVI_SETTINGS_CONNMAN_SERVICE_HPP + +#include "connman.hpp" +#include "connman_manager.hpp" + + +namespace ivi +{ + namespace settings + { + class response_callback; + + /** + * @class service + * + * @brief Connman Service object proxy. + * + * This class exposes functionality found in the connman + * @c Service interface to the caller. + */ + class service + { + public: + + /** + * Constructor. + * + * @param[in] service_path The D-Bus object path for connman + * service. + */ + service(std::string service_path); + + /// Connect to the service. + void connect(response_callback response); + + /// Disconnect from the service. + void disconnect(response_callback response); + + private: + + /** + * Call the method @a name on the connman Service object. + * + * @param[in] name The connman Service object method + * name. + * @param[inout] response Callback used to inform the caller of + * success or failure. + */ + void call_method(char const * name, + response_callback response); + + private: + + /// The proxy used to access the connman Service D-Bus API. + connman connman_; + + }; + + } +} + + +#endif /* IVI_SETTINGS_CONNMAN_SERVICE_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/plugins/connman/technology.cpp b/plugins/connman/technology.cpp new file mode 100644 index 0000000..bda9a1e --- /dev/null +++ b/plugins/connman/technology.cpp @@ -0,0 +1,357 @@ +/** + * @file technology.cpp + * + * @brief Connman technology request handling. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#include "technology.hpp" +#include "service.hpp" +#include <settingsd/response_callback.hpp> +#include <settingsd/glib_traits.hpp> +#include <settingsd/json_glib_traits.hpp> +#include <settingsd/smart_ptr.hpp> + +#include <cstring> +#include <chrono> + + +ivi::settings::technology::technology(std::string tech) + : connman_("net.connman.Technology", // Interface + ("/net/connman/technology/" + + tech).c_str()) // Object path + , manager_() + , technology_(tech) +{ +} + +void +ivi::settings::technology::handle_request(std::string request, + response_callback response) +{ + smart_ptr<JsonParser> const parser(json_parser_new()); + json_parser_load_from_data(parser.get(), request.c_str(), -1, nullptr); + + smart_ptr<JsonReader> const safe_reader( + json_reader_new(json_parser_get_root(parser.get()))); + JsonReader * const reader = safe_reader.get(); + + char const * name = nullptr; + if (json_reader_read_member(reader, "name")) + name = json_reader_get_string_value(reader); + else + response.send_error( + "Malformed " + technology_ + " request: missing 'name' element"); + + json_reader_end_member(reader); + + if (name != nullptr) { + if (strcmp(name, "is_enabled") == 0) + get_powered(reader, response); + else if (strcmp(name, "enable") == 0) + set_powered(reader, response); + else if (strcmp(name, "scan") == 0) + scan(reader, response); + else if (strcmp(name, "connect") == 0) + connect(reader, response); + else if (strcmp(name, "disconnect") == 0) + disconnect(reader, response); + else { + response.send_error( + "Unrecognized " + technology_ + " request name: " + + name); + } + } else { + response.send_error( + "Operation name for " + technology_ + " request is not a string."); + } +} + +void +ivi::settings::technology::get_powered(JsonReader * reader, + response_callback response) +{ + bool null = false; + if (json_reader_read_member(reader, "value")) { + null = json_reader_get_null_value(reader); + } + json_reader_end_member(reader); + + if (!null) { + response.send_error( + technology_ + " is_enabled parameter is not null."); + return; + } + + smart_ptr<GVariant> const property( + get_property("Powered", G_VARIANT_TYPE_BOOLEAN, response)); + + if (property != nullptr) { + bool const powered = g_variant_get_boolean(property.get()); + + response.send_response( + [powered](JsonBuilder * builder) + { + json_builder_set_member_name(builder, "value"); + json_builder_add_boolean_value(builder, powered); + }); + } + + // Error responses handled in get_property() method. +} + +void +ivi::settings::technology::set_powered(JsonReader * reader, + response_callback response) +{ + bool enable = false; + if (json_reader_read_member(reader, "value")) { + enable = json_reader_get_boolean_value(reader); + } + + json_reader_end_member(reader); + + constexpr char const name[] = "Powered"; + + // Get notified when the technology property has changed. + auto property_promise = connman_.get_property_changed_promise(name); + auto property_future = property_promise->get_future(); + + GError * error = nullptr; + + smart_ptr<GVariant> ret( + connman_.set_property(name, + g_variant_new_boolean(enable), + error)); + + smart_ptr<GError> safe_error(error); + + if (ret != nullptr) { + constexpr int const timeout = 5000; // milliseconds + + // Block until the technology property has changed.. + std::future_status const status = + property_future.wait_for(std::chrono::milliseconds(timeout)); + + if (status == std::future_status::ready) { + + // Nothing to add to successful response. + response.send_response( + [](JsonBuilder * /* builder */) {}); + + } else { + + response.send_error( + std::string("Wait for enable status failed: ") + + (status == std::future_status::timeout + ? "timeout" + : "deferred")); + + } + } else if (error != nullptr) { + response.send_error( + "Unable to set " + technology_ + " powered state: " + + error->message); + } else { + response.send_error( + "Malformed " + technology_ + " enable request value."); + } +} + +void +ivi::settings::technology::scan(JsonReader * reader, + response_callback response) +{ + bool null = false; + if (json_reader_read_member(reader, "value")) { + null = json_reader_get_null_value(reader); + } + json_reader_end_member(reader); + + if (!null) { + response.send_error(technology_ + " scan parameter is not null."); + return; + } + + // Get notified when scan results are available. + auto services_promise = manager_.get_services_changed_promise(); + auto services_future = services_promise->get_future(); + + // The scan could take a while. + constexpr gint const timeout = 10000; // milliseconds + GError * error = nullptr; + + smart_ptr<GVariant> const ret( + g_dbus_proxy_call_sync(connman_.proxy(), + "Scan", + nullptr, // No parameters + G_DBUS_CALL_FLAGS_NONE, + timeout, + nullptr, // Not cancellable + &error)); + + smart_ptr<GError> safe_error(error); + + if (ret != nullptr) { + constexpr gint const future_timeout = 5000; // milliseconds + + // Block until the scan results are in. + std::future_status const status = + services_future.wait_for(std::chrono::milliseconds(future_timeout)); + + if (status != std::future_status::deferred) { + // Don't call get() if the future isn't ready. Otherwise this + // will be a blocking call. + if (status == std::future_status::ready) { + smart_ptr<JsonNode> const changed_services(services_future.get()); + } + + send_services(response, error); + + // A timeout is okay since some services may not have changed + // within the timeout period but log it just in case. + if (status == std::future_status::timeout) + g_debug("%s settings: Timed out waiting for changed services.\n", + technology_.c_str()); + } else { + // We only get here if the future status is + // std::future_status::deferred, meaning the result hasn't been + // determined yet. That should never happen in our case. + response.send_error("Wait for scan results failed: deferred"); + } + } else if (error != nullptr) { + response.send_error( + "Unable to scan " + technology_ + ": " + + error->message); + } else { + response.send_error( + "Malformed " + technology_ + " scan request value."); + } +} + +void +ivi::settings::technology::connect(JsonReader * reader, + response_callback response) +{ + char const * service_path = nullptr; + if (json_reader_read_member(reader, "value")) { + service_path = json_reader_get_string_value(reader); + } + json_reader_end_member(reader); + + /// @todo Refactor malformed JSON request handling code. + if (service_path != nullptr) { + service s(service_path); + s.connect(response); + } else { + response.send_error( + "Malformed " + technology_ + " connect request value."); + } +} + +void +ivi::settings::technology::disconnect(JsonReader * reader, + response_callback response) +{ + char const * service_path = nullptr; + if (json_reader_read_member(reader, "value")) { + service_path = json_reader_get_string_value(reader); + } + json_reader_end_member(reader); + + if (service_path != nullptr) { + service s(service_path); + s.disconnect(response); + } else { + response.send_error( + "Malformed " + technology_ + " disconnect request value."); + } +} + +void +ivi::settings::technology::send_services(response_callback response, + GError *& error) +{ + smart_ptr<GVariant> const services(manager_.get_services(error)); + + if (services != nullptr) { + response.send_response( + [&services](JsonBuilder * builder) + { + /** + * @todo Can @c json_gvariant_serialize() ever return a nullptr? + */ + JsonNode * const value = + json_gvariant_serialize(services.get()); + + json_builder_set_member_name(builder, "value"); + json_builder_add_value(builder, value); + + // No need to free the JsonNode. The builder will take + // ownership of it. + }); + } +} + +GVariant * +ivi::settings::technology::get_property(char const * name, + GVariantType const * type, + response_callback response) +{ + GError * error = nullptr; + + smart_ptr<GVariant> const properties( + manager_.get_properties(technology_, error)); + + smart_ptr<GError> safe_error(error); + + smart_ptr<GVariant> property; + if (properties != nullptr) { + property.reset( + g_variant_lookup_value(properties.get(), name, type)); + + if (property == nullptr) { + response.send_error( + "Internal " + technology_ + + "error: \"" + name + "\" property lookup failed."); + } + } else if (error != nullptr) { + response.send_error( + "Unable to get " + technology_ + "properties: " + + error->message); + } else { + // This scenario will occur if the technology doesn't exist on + // the platform. For example, attempting to retrieve the wifi + // "Powered" property on a platform without supported hardware + // will result in this error. + response.send_error(technology_ + " properties are not available."); + } + + return property.release(); +} + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/plugins/connman/technology.hpp b/plugins/connman/technology.hpp new file mode 100644 index 0000000..44fdef6 --- /dev/null +++ b/plugins/connman/technology.hpp @@ -0,0 +1,139 @@ +/** + * @file technology.hpp + * + * @brief Connman technology request handling. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#ifndef IVI_SETTINGS_CONNMAN_TECHNOLOGY_HPP +#define IVI_SETTINGS_CONNMAN_TECHNOLOGY_HPP + +#include "connman.hpp" +#include "connman_manager.hpp" + +#include <json-glib/json-glib.h> + + +namespace ivi +{ + namespace settings + { + class response_callback; + + /** + * @class technology + * + * @brief Common technology-based settings functionality. + * + * This class implements functionality common to all technology-based + * settings, such as bluetooth, wifi, date/time, etc. + */ + class technology + { + public: + + /** + * Constructor. + * + * @param[in] tech The connman technology, e.g. "bluetooth". + */ + technology(std::string tech); + + /// Handle requests common to all connman technologies. + void handle_request(std::string request, + response_callback response); + + private: + + /// Get technology "Powered" state. + void get_powered(JsonReader * reader, + response_callback response); + + /// Set technology "Powered" state. + void set_powered(JsonReader * reader, + response_callback response); + + /** + * Scan for services that implement the technology, e.g. WiFi + * access points. + */ + void scan(JsonReader * reader, + response_callback response); + + /** + * Connect to service whose object path is found in the JSON + * request. + */ + void connect(JsonReader * reader, + response_callback response); + + /** + * Disconnect from service whose object path is found in the + * JSON request. + */ + void disconnect(JsonReader * reader, + response_callback response); + + /// Send list of services to caller. + void send_services(response_callback response, + GError *& error); + + /** + * Get property for this technology. + * + * @param[in] name Name of the connman technology property + * to retrieve. + * @param[in] type The type of property being retrieved. + * @param[in] response The response callback through errors will + * be sent to the caller. + * + * @returns A @c GVariant containing the retrieved property. + */ + GVariant * get_property(char const * name, + GVariantType const * type, + response_callback response); + + private: + + /// The proxy used to access the connman Technology D-Bus API. + connman connman_; + + /// The proxy used to access the connman Manager D-Bus API. + connman_manager manager_; + + /// Technology name, e.g. "bluetooth" or "wifi". + std::string const technology_; + + }; + + } +} + + +#endif /* IVI_SETTINGS_CONNMAN_TECHNOLOGY_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/plugins/connman/wifi.cpp b/plugins/connman/wifi.cpp new file mode 100644 index 0000000..15bebe6 --- /dev/null +++ b/plugins/connman/wifi.cpp @@ -0,0 +1,66 @@ +/** + * @file wifi.cpp + * + * @brief Connman-based wifi settings. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#include "wifi.hpp" +#include <settingsd/response_callback.hpp> + +// ---------------------------------------------------------------------- + +namespace +{ + std::string const technology_name("wifi"); +} + +// ---------------------------------------------------------------------- + +ivi::settings::wifi::wifi() + : technology_(technology_name) +{ +} + +ivi::settings::wifi::~wifi() +{ +} + +std::string const & +ivi::settings::wifi::id() const +{ + return technology_name; +} + +void +ivi::settings::wifi::handle_request(std::string request, + response_callback response) +{ + technology_.handle_request(request, response); +} + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/plugins/connman/wifi.hpp b/plugins/connman/wifi.hpp new file mode 100644 index 0000000..d82c82b --- /dev/null +++ b/plugins/connman/wifi.hpp @@ -0,0 +1,98 @@ +/** + * @file wifi.hpp + * + * @brief Wifi settings plugin. + * + * Connman-based wifi settings plugin. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2012, 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + * + * @note This header is internal. Settings provider plugin implementors + * should write their own library/symbol export macros as + * needed. + */ + + +#ifndef IVI_SETTINGS_CONNMAN_WIFI_HPP +#define IVI_SETTINGS_CONNMAN_WIFI_HPP + +#include <settingsd/plugin.hpp> + +#include "technology.hpp" + + +namespace ivi +{ + namespace settings + { + class response_callback; + + /** + * @class wifi + * + * @brief Connman-based wifi settings. + * + * This class implements all connman-based wifi settings. + */ + class wifi : public plugin + { + public: + + /// Constructor. + wifi(); + + /// Destructor. + virtual ~wifi(); + + /** + * @name Settings Plugin API + * + * Interface defined by the @c ivi::settings::plugin abstract + * base class. + * + * @see settingsd/plugin.hpp + */ + //@{ + virtual std::string const & id() const; + virtual void handle_request(std::string request, + response_callback response); + //@} + + private: + + /// Underlying connman proxy. + technology technology_; + + }; + + } +} + + +#endif /* IVI_SETTINGS_CONNMAN_WIFI_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: + diff --git a/settingsd.dox b/settingsd.dox new file mode 100644 index 0000000..faadc51 --- /dev/null +++ b/settingsd.dox @@ -0,0 +1,57 @@ +/** + * @mainpage Settingsd - Tizen IVI Settings Daemon + * + * + * + * @section settingsd_main_sec settingsd + * + * + * @subsection config_sec Configuration + * + * + * @note Command line parameters have precedence over their + * configuration file counterparts. + * + * @section plugins_sec Writing Settingsd Plugins + * + * All settingsd plugins must implement two functions with C linkage: + * + * @code + * extern "C" ivi::settings::plugin * make_settings(); + * extern "C" void destroy_settings(ivi::settings::plugin *); + * @endcode + * + * Both functions must be exported from the plugin if compile- or + * link-time symbol hiding is enabled. There is no need to export + * the plugin subclass itself since it will only be invoked through + * the @c ivi::settings::plugin base class. + * + * @subsection make_settings make_settings() + * + * The @c make_settings() function is a factory function that returns a + * pointer to an object that implements the @c ivi::settings::plugin + * interface (i.e. subclasses @c ivi::settings::plugin). The settingsd + * plugin framework does not require @c ivi::settings::plugin + * instances to be allocated in a particular way, but one would + * typically create an instance using @c operator @c new(). + * + * @see the @c ivi::settings::plugin abstract base class for further + * documentation, including the required @c @#include directive. + * + * @subsection destroy_settings destroy_settings() + * + * The @c destroy_provider() function will be called by the settingsd + * plugin framework when it no longer needs the provider in + * question. The settingsd plugin framework does not require + * @c ivi::settings::plugin instances to be deallocated in a + * particular way, but one would typically destroy instances using + * @c operator @c delete(), assuming it was created using @c operator + * @c new() in the plugin's @c make_settings() function. + * + * @subsection linking Link-time Dependencies + * + * Settingsd plugins must link against the settingsd library, @e e.g. + * @c libsettings on Unix-like platforms. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + */ diff --git a/settingsd.org b/settingsd.org new file mode 100644 index 0000000..1625261 --- /dev/null +++ b/settingsd.org @@ -0,0 +1,15 @@ +* Security +** TODO Implement SMACK based access control. + Currently any application may connect to the settings daemon's web + socket, and invoke operations. This is of course a security hole + that needs to be closed. To do that a SMACK based approach should + employed to limit access to authorized applications, such as the + settings app. However, this is not straightforward for Web apps + since they all run in the same domain. A policy framework is + currently being discussed to address this issue. + +* Concurrency +** TODO Determine if it makes sense to make the settings daemon multithreaded. + +* Miscellaneous +** TODO Validate websocket server port chosen by user. diff --git a/src/Makefile.am b/src/Makefile.am new file mode 100644 index 0000000..d3c7b01 --- /dev/null +++ b/src/Makefile.am @@ -0,0 +1,74 @@ +## Copyright 2012, 2013 Intel Corporation All Rights Reserved. +## +## This library is free software; you can redistribute it and/or +## modify it under the terms of the GNU Lesser General Public +## License as published by the Free Software Foundation; +## version 2.1 of the License. +## +## This library 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 +## Lesser General Public License for more details. +## +## You should have received a copy of the GNU Lesser General Public +## License along with this library; if not, write to the Free Software +## Foundation, Inc., 51 Franklin Street, Fifth Floor, +## Boston, MA 02110-1301 USA + +## --------------------------------------------------------- +## settings daemon +## --------------------------------------------------------- + +# The settingsd stand-alone binary. +bin_PROGRAMS = settingsd + +## Note that we define some preprocessor symbols on the command line +## since the required shell variables cannot be fully expanded at +## configure-time. +settingsd_CPPFLAGS = \ + $(BOOST_CPPFLAGS) \ + $(GIO_CFLAGS) \ + $(JSON_GLIB_CFLAGS) \ + $(LIBWEBSOCKETS_CFLAGS) \ + -I$(top_srcdir)/include \ + -DIVI_SETTINGS_CONFIG_DIR='"$(sysconfdir)/@PACKAGE@"' \ + -DIVI_SETTINGS_DEFAULT_SETTINGS_DIR='"$(pkglibdir)"' + +settingsd_SOURCES = \ + configurator.cpp \ + daemon.cpp \ + websocket_server.cpp + +settingsd_LDFLAGS = $(BOOST_LDFLAGS) + +settingsd_LDADD = \ + $(top_builddir)/lib/libsettings.la \ + $(BOOST_PROGRAM_OPTIONS_LIB) \ + $(JSON_GLIB_LIBS) \ + $(GIO_LIBS) \ + $(LIBWEBSOCKETS_LIBS) \ + @IVI_SETTINGS_DLOPEN_LIBS@ + +noinst_HEADERS = \ + configurator.hpp \ + websocket_server.hpp + + +## Silent mode output for D-bus related code generation. +dbus_codegen_verbose = $(dbus_codegen_verbose_$(V)) +dbus_codegen_verbose_ = $(dbus_codegen_verbose_$(AM_DEFAULT_VERBOSITY)) +dbus_codegen_verbose_0 = @echo 'CODEGEN ' $@; + +## Geocoding related D-bus glue code generation. +%-glue.c %-glue.h: %.xml Makefile + $(dbus_codegen_verbose)gdbus-codegen --generate-c-code $*-glue \ + --interface-prefix org.tizen. $< + +BUILT_SOURCES = + +CLEANFILES = $(BUILT_SOURCES) + +dist-hook: + cd $(distdir); rm -f $(BUILT_SOURCES) + +EXTRA_DIST = diff --git a/src/configurator.cpp b/src/configurator.cpp new file mode 100644 index 0000000..bcf374b --- /dev/null +++ b/src/configurator.cpp @@ -0,0 +1,251 @@ +/** + * @file configurator.cpp + * + * @brief Source file containing implementation of the settingsd + * configuration manager. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2012, 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + + +#include "../lib/config.hpp" +#include "configurator.hpp" + +#include <unistd.h> +#include <fstream> +#include <cstdlib> + + +namespace po = boost::program_options; + +ivi::settings::configurator::configurator(int & argc, + char * argv[], + char const * /* logger_name */) + : vm_() +{ + parse_config(argc, argv); +} + +std::string +ivi::settings::configurator::settings_dir() const +{ + return vm_["settings-dir"].as<std::string>(); +} + +int +ivi::settings::configurator::websocket_port() const +{ + return vm_["websocket-port"].as<int>(); +} + +char const * +ivi::settings::configurator::ssl_cert_file() const +{ + return libwebsocket_ssl_filepath("ssl-cert-file"); +} + +char const * +ivi::settings::configurator::ssl_private_key_file() const +{ + return libwebsocket_ssl_filepath("ssl-private-key-file"); +} + +char const * +ivi::settings::configurator::ssl_ca_file() const +{ + return libwebsocket_ssl_filepath("ssl-ca-file"); +} + +void +ivi::settings::configurator::parse_config(int & argc, char * argv[]) +{ + /// Options recognized by settingsd. + boost::program_options::options_description desc( + "Allowed " PACKAGE " options"); + + desc.add_options() + ("settings-dir", + po::value<std::string>()->default_value(IVI_SETTINGS_DEFAULT_SETTINGS_DIR), + "settings plugin directory") + ("websocket-port", + po::value<int>()->default_value(IVI_SETTINGS_DEFAULT_WEBSOCKET_PORT), + "settings web socket server TCP/IP port") + ("ssl-cert-file", + po::value<std::string>(), + "SSL server certificate file") + ("ssl-private-key-file", + po::value<std::string>(), + "SSL private key file") + ("ssl-ca-file", + po::value<std::string>(), + "SSL CA certificate file") + ("version", "display version information") + ("help", "display help message"); + + // Option precedence - high to low: + // + // 1. Command line + // 2. User config + // 3. System config + // + // The store() function will only assign a value once, and will + // not change it's value subsequently. + po::store(po::parse_command_line(argc, argv, desc), vm_); + + /** + * @todo Check for config in $XDG_CONFIG_DIRS and $XDG_CONFIG_HOME. + */ + // User config is stored in ~/.config/ivi_settings. + std::ifstream user_config_file(std::string(std::getenv("HOME")) + + "/.config/" PACKAGE); + if (user_config_file) + po::store(po::parse_config_file(user_config_file, desc), vm_); + + // Configuration file name such as + // "/etc/settingsd/settingsd.conf" + static char const config_filename[] = + IVI_SETTINGS_CONFIG_DIR "/" PACKAGE ".conf"; + + std::ifstream system_config_file(config_filename); + if (system_config_file) + po::store(po::parse_config_file(system_config_file, desc), vm_); + + po::notify(vm_); + + if (vm_.count("version")) { + display_version_info(); + std::exit(EXIT_SUCCESS); + } else if (vm_.count("help")) { + std::cout << desc << std::endl; + std::exit(EXIT_SUCCESS); + } +} + +void +ivi::settings::configurator::display_version_info() const +{ + static char const copyright[] = + PACKAGE_STRING "\n" + "Copyright (c) 2012, 2013 Intel Corporation.\n" + "\n" + "This " PACKAGE_NAME " (\"Software\") is furnished under " + "license and may only be\n" + "used or copied in accordance with the terms of that license.\n" + "No license, express or implied, by estoppel or otherwise, to any\n" + "intellectual property rights is granted by this document. The\n" + "Software is subject to change without notice, and should not be\n" + "construed as a commitment by Intel Corporation to market, license,\n" + "sell or support any product or technology. Unless otherwise provided\n" + "for in the license under which this Software is provided, the\n" + "Software is provided AS IS, with no warranties of any kind, express\n" + "or implied. Except as expressly permitted by the Software license,\n" + "neither Intel Corporation nor its suppliers assumes any\n" + "responsibility or liability for any errors or inaccuracies that may\n" + "appear herein. Except as expressly permitted by the Software\n" + "license, no part of the Software may be reproduced, stored in a\n" + "retrieval system, transmitted in any form, or distributed by any\n" + "means without the express written consent of Intel Corporation.\n"; + + std::cout << copyright << std::endl; +} + +void +ivi::settings::configurator::configure_logger( + char const * /* logger_name */) +{ + // Start with log configuration file, if it exists, and override as + // needed with command line specifed options. + std::string const log_config_filename = + vm_["log-config-file"].as<std::string>(); + + if (access(log_config_filename.c_str(), R_OK) == 0) { + /** + * @bug There is a TOCTOU race here since the config file may + * be yanked out from under us before the + * @c log4plus::PropertyConfigurator pulls the config from + * the file. + */ + + // Reset configuration before pulling configuration from file. + // log4cplus::Logger::getDefaultHierarchy().resetConfiguration(); + + // Now pull the configuration from the file. + // log4cplus::PropertyConfigurator::doConfigure(log_config_filename); + } + + // logger_ = log4cplus::Logger::getInstance(logger_name); + + /// @todo Set the log file. + + // We have a logger. Now set the log level. + set_log_level(); +} + +void +ivi::settings::configurator::set_log_level() +{ +/* + log4cplus::LogLevel level; + + std::string const l = vm_["log-level"].as<std::string>(); + + if (l == "FATAL") + level = log4cplus::FATAL_LOG_LEVEL; + else if (l == "ERROR") + level = log4cplus::ERROR_LOG_LEVEL; + else if (l == "WARN") + level = log4cplus::WARN_LOG_LEVEL; + else if (l == "INFO") + level = log4cplus::INFO_LOG_LEVEL; + else if (l == "DEBUG") + level = log4cplus::DEBUG_LOG_LEVEL; + else if (l == "TRACE") + level = log4cplus::TRACE_LOG_LEVEL; + else if (l == "ALL") + level = log4cplus::ALL_LOG_LEVEL; + else if (l == "OFF") + level = log4cplus::OFF_LOG_LEVEL; + else { + LOG4CPLUS_WARN(logger_, "Unknown log option: \"" + l + "\""); + return; + } + + logger_.setLogLevel(level); +*/ +} + +char const * +ivi::settings::configurator::libwebsocket_ssl_filepath( + std::string const & option) const +{ + using boost::program_options::variable_value; + + variable_value const & value = vm_[option]; + + return value.empty() ? nullptr : value.as<std::string>().c_str(); +} + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/src/configurator.hpp b/src/configurator.hpp new file mode 100644 index 0000000..7187aad --- /dev/null +++ b/src/configurator.hpp @@ -0,0 +1,125 @@ +/** + * @file configurator.hpp + * + * @brief settingsd configuration manager header. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2012, 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + * + * @note This is an internal header. + */ + +#ifndef IVI_SETTINGS_CONFIGURATOR_HPP +#define IVI_SETTINGS_CONFIGURATOR_HPP + +#include <string> +#include <boost/program_options.hpp> + + +namespace ivi { + namespace settings{ + /** + * @class configurator + * + * @brief Settingsd configuration manager + * + * The @c configurator class parses command line and file based + * settingsd configuration options. + */ + class configurator + { + public: + + /// Constructor. + configurator(int & argc, char * argv[], char const * logger_name); + + /// Get directory containing the settings plugins. + std::string settings_dir() const; + + /// The port on which the web socket server should listen. + int websocket_port() const; + + + /// Websocket server SSL certificate file. + char const * ssl_cert_file() const; + + /// Websocket server SSL private key file. + char const * ssl_private_key_file() const; + + /// Websocket server SSL CA certificate file. + char const * ssl_ca_file() const; + + private: + + /** + * @name Prevent copying + */ + //@{ + configurator(configurator const &) = delete; + configurator & operator=(configurator const &) = delete; + //@} + + /** + * @brief Parse the settingsd configuration. + * + * Configuration options are obtained from the command line, the + * user configuration file and the system configuration file, in + * order of decreasing precedence. + */ + void parse_config(int & argc, char * argv[]); + + /// Display settingsd's version and copyright notices. + void display_version_info() const; + + /// Configure the underlying logger. + void configure_logger(char const * logger_name); + + /// Set the log level in the underlying logger. + void set_log_level(); + + /** + * libwebsockets wants a @c nullptr for SSL certificate/key + * paths if they won't be used. + * + * @param[in] option SSL certificate relate program option. + * + * @returns C string if @a option is not empty, @c nullptr + * otherwise. + */ + char const * libwebsocket_ssl_filepath( + std::string const & option) const; + + private: + + /// Map of settingsd program options. + boost::program_options::variables_map vm_; + + }; + } +} + +#endif /* IVI_SETTINGS_CONFIGURATOR_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/src/daemon.cpp b/src/daemon.cpp new file mode 100644 index 0000000..a657483 --- /dev/null +++ b/src/daemon.cpp @@ -0,0 +1,78 @@ +/** + * @file daemon.cpp + * + * @brief Main settingsd source file. + * + * @copyright @par + * Copyright 2012, 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#include "../lib/config.hpp" +#include "../lib/manager.hpp" + +#include "configurator.hpp" +#include "websocket_server.hpp" + +#include <settingsd/glib_traits.hpp> +#include <settingsd/smart_ptr.hpp> + +#include <glib.h> +#include <iostream> + + +/** + * settingsd program entry point. + * + * @param[in] argc The number of settingsd command line arguments. + * @param[in] argv The settingsd command line option/argument vector. + */ +int +main(int argc, char * argv[]) +{ + std::cerr << PACKAGE_STRING << '\n'; + + try { + using namespace ivi; + + settings::configurator config(argc, argv, IVI_SETTINGS_DBUS_NAME); + + settings::manager manager(config.settings_dir()); + + // The websocket server will run in its own thread. + settings::websocket_server server(config, manager); + server.run(); + + // Glib related events, including GDbus related signal handlers, + // will handled in this (main) thread. + settings::smart_ptr<GMainLoop> const loop(g_main_loop_new(nullptr, false)); + g_main_loop_run(loop.get()); + } + catch (std::exception & e) { + std::cerr << e.what(); + return -1; + } + + return 0; +} + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/src/websocket_server.cpp b/src/websocket_server.cpp new file mode 100644 index 0000000..e454839 --- /dev/null +++ b/src/websocket_server.cpp @@ -0,0 +1,172 @@ +/** + * @file websocket_server.cpp + * + * @brief Settings daemon WebSocket server source. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#include "websocket_server.hpp" +#include "configurator.hpp" +#include "../lib/config.hpp" +#include "../lib/manager.hpp" + +#include <stdexcept> +#include <thread> + + +namespace +{ + // -------------------------------------------------------------------- + // libwebsockets callbacks and related data. + // -------------------------------------------------------------------- + + int + callback_ivi_settings(libwebsocket_context * context, + libwebsocket * wsi, + enum libwebsocket_callback_reasons reason, + void * /* user */, + void * in, + size_t /* len */) + { + using namespace ivi::settings; + + manager * const mgr = static_cast<manager *>( + libwebsocket_context_user(context)); + + switch(reason) { + case LWS_CALLBACK_RECEIVE: + // Request has come in from Settings app. Pass it on to the + // settings manager. + mgr->dispatch(static_cast<char const *>(in), wsi); + break; + + default: + break; + } + + return 0; + } + + struct ws_session_data_type + { + }; + + libwebsocket_protocols settings_protocols[] = { + { + "http-only",//"ivi-settings-protocol", + callback_ivi_settings, + sizeof(ws_session_data_type), + 0, + nullptr, + 0 + }, + { + nullptr, + nullptr, + 0, + 0, + nullptr, + 0 + } + }; + +} + +// ---------------------------------------------------------------------- + +ivi::settings::websocket_server::websocket_server( + ivi::settings::configurator const & config, + ivi::settings::manager & mgr) + : context_(nullptr) +{ + lws_context_creation_info info; + info.port = config.websocket_port(); + info.iface = "lo"; // Only allow communication over the loopback + // interface. + + info.protocols = settings_protocols; + info.extensions = libwebsocket_get_internal_extensions(); + + info.ssl_cert_filepath = config.ssl_cert_file(); + info.ssl_private_key_filepath = config.ssl_private_key_file(); + info.ssl_ca_filepath = config.ssl_ca_file(); + info.ssl_cipher_list = nullptr; + + info.gid = -1; + info.uid = -1; + + info.options = 0; + + info.user = &mgr; + + info.ka_time = 0; + info.ka_probes = 0; + info.ka_interval = 0; + + lws_set_log_level(LLL_INFO, lwsl_emit_syslog); + + context_ = libwebsocket_create_context(&info); + if (context_ == nullptr) + throw std::runtime_error("Unable to initialize websocket.\n"); + + std::cout << "\n" PACKAGE_NAME " listening for requests on port " + << info.port << ".\n"; +} + +ivi::settings::websocket_server::~websocket_server() +{ + libwebsocket_context_destroy(context_); +} + +void +ivi::settings::websocket_server::run() +{ + // Run the websocket event loop in its own thread. + std::thread( + [](libwebsocket_context * context){ + try { + // Run the libwebsockets event loop with an infinite timeout. + // The negative timeout causes the underlying call poll() to + // block indefinitely until an event occurs. + constexpr int const timeout = -1; + while (libwebsocket_service(context, timeout) >= 0) { + } + + std::cerr << "WebSocket event loop ended.\n"; + } catch(std::exception & e) { + std::cerr << e.what() << std::endl; + } + }, + context_).detach(); +} + + +/** + * @todo Add 'state' event do determine whether technology is + * enabled/disabled. + */ + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/src/websocket_server.hpp b/src/websocket_server.hpp new file mode 100644 index 0000000..c7a6e09 --- /dev/null +++ b/src/websocket_server.hpp @@ -0,0 +1,92 @@ +/** + * @file websocket_server.hpp + * + * @brief Settings daemon WebSocket server header. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + * + * @note This header is internal. + */ + +#ifndef IVI_SETTINGS_WEBSOCKET_SERVER_HPP +#define IVI_SETTINGS_WEBSOCKET_SERVER_HPP + +#include <libwebsockets.h> + + +namespace ivi +{ + namespace settings + { + class configurator; + class manager; + + /** + * @class websocket_server + * + * @brief IVI Settings web socket server + * + * This class implements the server that listens for and handles + * web socket events. + */ + class websocket_server + { + public: + + /// Constructor. + websocket_server(configurator const & config, + manager & manager); + + /// Destructor. + ~websocket_server(); + + /// Run the websocket server event loop in its own thread. + void run(); + + private: + + /** + * @name Prevent copying + */ + //@{ + websocket_server(websocket_server const &) = delete; + websocket_server & operator=(websocket_server const &) = delete; + //@} + + private: + + /// Our libwebsocket state. + libwebsocket_context * context_; + + }; + + } +} + + +#endif /* IVI_SETTINGS_WEBSOCKET_SERVER_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/tests/Makefile.am b/tests/Makefile.am new file mode 100644 index 0000000..905fe72 --- /dev/null +++ b/tests/Makefile.am @@ -0,0 +1,60 @@ +## Copyright 2013 Intel Corporation All Rights Reserved. +## +## This library is free software; you can redistribute it and/or +## modify it under the terms of the GNU Lesser General Public +## License as published by the Free Software Foundation; +## version 2.1 of the License. +## +## This library 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 +## Lesser General Public License for more details. +## +## You should have received a copy of the GNU Lesser General Public +## License along with this library; if not, write to the Free Software +## Foundation, Inc., 51 Franklin Street, Fifth Floor, +## Boston, MA 02110-1301 USA + +pkglib_LTLIBRARIES = test_setting.la + +if SETTINGS_USE_GCC_SYMBOL_VISIBILITY + SETTINGS_PLUGIN_CXXFLAGS = \ + -fvisibility=hidden \ + -fvisibility-inlines-hidden +else + SETTINGS_PLUGIN_CXXFLAGS = +endif + +SETTINGS_PLUGIN_CPPFLAGS = \ + -DTEST_SETTING_BUILDING_DLL \ + -I$(top_srcdir)/include +SETTINGS_PLUGIN_LIBRARY = $(top_builddir)/lib/libsettings.la + +test_setting_la_SOURCES = test_setting.cpp +test_setting_la_LIBADD = $(SETTINGS_PLUGIN_LIBRARY) +test_setting_la_LDFLAGS = -no-undefined -module -avoid-version +test_setting_la_CXXFLAGS = \ + $(SETTINGS_PLUGIN_CXXFLAGS) \ + $(JSON_GLIB_CFLAGS) \ + $(LIBWEBSOCKETS_CFLAGS) +test_setting_la_CPPFLAGS = $(SETTINGS_PLUGIN_CPPFLAGS) + +noinst_HEADERS = test_setting_api.hpp test_setting.hpp + +noinst_PROGRAMS = settings_test + +settings_test_SOURCES = settings_test.cpp + +settings_test_LDFLAGS = $(BOOST_LDFLAGS) + +settings_test_LDADD = \ + $(LIBWEBSOCKETS_LIBS) +# -lboost_unit_test_framework + +settings_test_CPPFLAGS = \ + $(LIBWEBSOCKETS_CFLAGS) \ + -I$(top_srcdir)/src \ + -I$(top_srcdir)/include \ + -DPLUGIN_DIR=\"$(top_builddir)/tests/\" + +#TESTS = $(noinst_PROGRAMS) diff --git a/tests/settings_test.cpp b/tests/settings_test.cpp new file mode 100644 index 0000000..7ea1ffa --- /dev/null +++ b/tests/settings_test.cpp @@ -0,0 +1,250 @@ +/** + * @file settings_test.cpp + * + * @brief Settings daemon test. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + * + * @note This header is internal. + */ + +#include "../lib/config.hpp" + +#include <libwebsockets.h> + +#include <iostream> +#include <vector> + + +namespace +{ + // -------------------------------------------------------------------- + // libwebsockets callbacks and related data. + // -------------------------------------------------------------------- + + int + send_request(libwebsocket_context * /* context */, libwebsocket * wsi) + { + static char const request[] = + // "{" + // " \"type\": \"test_setting\"," + // " \"transactionid\": \"fnord\"," + // " \"name\": \"some_arbitrary_method\"," + // " \"value\": \"some_arbitrary_value\"" + // "}"; + + "{" + " \"type\": \"ethernet\"," + " \"transactionid\": \"fnord\"," + " \"name\": \"is_enabled\"," + " \"value\": null" + "}"; + + // "{" + // " \"type\":\"wifi\"," + // " \"transactionid\":\"3b5c9ebe-23fa-6b58-3f50-1203d7641441\"," + // " \"name\":\"scan\"," + // " \"value\":null" + // "}"; + + // "{" + // " \"type\":\"wifi\"," + // " \"transactionid\":\"3b5c9ebe-23fa-6b58-3f50-1203d7641441\"," + // " \"name\":\"connect\"," + // " \"value\":{" + // " \"ssid\":\"/net/connman/service/wifi_0c8bfd22b497_4775657374_managed_none\"," + // " \"security\":null," + // " \"passcode\":null}" + // "}"; + + // "{" + // " \"type\": \"clock\"," + // " \"transactionid\": \"fnord\"," + // " \"name\": \"time_updates\"," + // " \"value\": \"auto\"" + // "}"; + + + // libwebsockets wants a sequence of octets (unsigned char *) rather + // than characters. + typedef std::vector<unsigned char> vector_type; + + static vector_type::size_type const request_len = + sizeof(request) - 1; // Don't include null terminator. + + vector_type::size_type const buf_len = + LWS_SEND_BUFFER_PRE_PADDING + + request_len + + LWS_SEND_BUFFER_POST_PADDING; + + vector_type buf(buf_len); + unsigned char * const payload = + buf.data() + LWS_SEND_BUFFER_PRE_PADDING; + + // Copy the string into the buffer after libwebsockets pre-padding. + std::copy(std::begin(request), + std::end(request) - 1, // Don't include null terminator. + payload); + + int const count = libwebsocket_write(wsi, + payload, + request_len, + LWS_WRITE_TEXT); + + std::cout << "WROTE " << count << " bytes of " << request_len << "\n"; + + if (count < 0 || count < static_cast<int>(request_len)) + return -1; + + return 0; + } + + int + callback_settings_test(libwebsocket_context * context, + libwebsocket * wsi, + enum libwebsocket_callback_reasons reason, + void * /* user */, + void * in, + size_t /* len */) + { + // For LWS_CALLBACK_*_POLL_FD cases. + // int const fd = static_cast<int>(reinterpret_cast<intptr_t>(in)); + // short const events = static_cast<short>(len); + + switch(reason) { + case LWS_CALLBACK_CLIENT_RECEIVE: + // Response has come in from Settings daemon. + std::cout << "Response: " << static_cast<char const *>(in) << std::endl; + break; + case LWS_CALLBACK_CLIENT_ESTABLISHED: + libwebsocket_callback_on_writable(context, wsi); + break; + case LWS_CALLBACK_CLIENT_WRITEABLE: + return send_request(context, wsi); + default: + break; + } + + return 0; + } + + struct ws_session_data_type + { + }; + + libwebsocket_protocols settings_protocols[] = { + { + "http-only", + callback_settings_test, + sizeof(ws_session_data_type), + 0, + nullptr, + 0 + }, + { + nullptr, + nullptr, + 0, + 0, + nullptr, + 0 + } + }; +} + +// ---------------------------------------------------------------------- + +/** + * settings_test program entry point. + */ +int main() +{ + lws_context_creation_info info; + + info.port = 0; + info.iface = "lo"; + + info.protocols = settings_protocols; + info.extensions = libwebsocket_get_internal_extensions(); + + info.ssl_cert_filepath = nullptr; + info.ssl_private_key_filepath = nullptr; + info.ssl_ca_filepath = nullptr; + info.ssl_cipher_list = nullptr; + + info.gid = -1; + info.uid = -1; + + info.options = 0; + + info.user = nullptr; + + info.ka_time = 0; + info.ka_probes = 0; + info.ka_interval = 0; + + // lws_set_log_level(LLL_INFO, lwsl_emit_syslog); + + libwebsocket_context * const context = + libwebsocket_create_context(&info); + if (context == nullptr) + exit(EXIT_FAILURE); + + static char const address[] = "localhost"; + static int const port = IVI_SETTINGS_DEFAULT_WEBSOCKET_PORT; + static int ssl_connection = 0; // Unencrypted Websocket connection. + static char const path[] = "/"; + static char const host[] = "localhost"; + static char const origin[] = "localhost"; + static char const protocol[] = "http-only"; + static int const ietf_version = -1; // Connect using latest + // supported protocol. + + libwebsocket * const wsi = + libwebsocket_client_connect (context, + address, + port, ssl_connection, + path, + host, + origin, + protocol, + ietf_version); + + if (wsi == nullptr) { + std::cerr << "Unable to connect to settings daemon.\n"; + libwebsocket_context_destroy(context); + exit(EXIT_FAILURE); + } + + int n = 0; + while (n >= 0) + n = libwebsocket_service(context, 10); + + libwebsocket_context_destroy(context); + return 0; +} + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/tests/test_setting.cpp b/tests/test_setting.cpp new file mode 100644 index 0000000..af25ff8 --- /dev/null +++ b/tests/test_setting.cpp @@ -0,0 +1,89 @@ +/** + * @file test_setting.cpp + * + * @brief Settings daemon test plugin. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + +#include "test_setting_api.hpp" +#include "test_setting.hpp" +#include <settingsd/response_callback.hpp> +#include <settingsd/registrar.hpp> + +#include <memory> +#include <iostream> + + +test_setting::test_setting() +{ +} + +test_setting::~test_setting() +{ +} + +std::string const & +test_setting::id() const +{ + static std::string const name("test_setting"); + return name; +} + +void +test_setting::handle_request(std::string request, + ivi::settings::response_callback response) +{ + std::cout << "test_setting received request:\n" + << request << std::endl; + + if (response.type() != id()) { + response.send_error("Response type mismatch. Got \"" + + response.type() + + "\". Expected \"" + + id() + + "\"."); + return; + } + + // Nothing to add to successful response. + response.send_response( + [](JsonBuilder * /* builder */) {}); +} + +// ----------------------------------------------------------------------- + +/// Plugin factory/registration function. +extern "C" TEST_SETTING_API bool +register_settings(ivi::settings::registrar & r) +{ + std::unique_ptr<ivi::settings::plugin> test(new test_setting); + + return r.register_setting(std::move(test)); +} + + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: diff --git a/tests/test_setting.hpp b/tests/test_setting.hpp new file mode 100644 index 0000000..58fb0f2 --- /dev/null +++ b/tests/test_setting.hpp @@ -0,0 +1,81 @@ +/** + * @file test_setting.hpp + * + * @brief Settings daemon test plugin. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + * + * @note This header is internal. Settings provider plugin implementors + * should write their own library/symbol export macros as + * needed. + */ + + +#ifndef TEST_SETTING_HPP +#define TEST_SETTING_HPP + +#include <settingsd/plugin.hpp> + + +/** + * @class test_setting + * + * @brief Settings daemon test plugin. + * + * This test plugin responds to settings test requests and + * provides test responses, accordingly. + */ +class test_setting : public ivi::settings::plugin +{ +public: + + /// Constructor. + test_setting(); + + /// Destructor. + virtual ~test_setting(); + + /** + * @name Settings Plugin API + * + * Interface defined by the @c ivi::settings::plugin abstract + * base class. + * + * @see settingsd/plugin.hpp + */ + //@{ + virtual std::string const & id() const; + virtual void handle_request(std::string request, + ivi::settings::response_callback response); + //@} + +}; + + +#endif /* TEST_SETTING_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: + diff --git a/tests/test_setting_api.hpp b/tests/test_setting_api.hpp new file mode 100644 index 0000000..d3e4096 --- /dev/null +++ b/tests/test_setting_api.hpp @@ -0,0 +1,66 @@ +/** + * @file test_setting_api.hpp + * + * @brief @c Test_Setting-based settings plugin export macros. + * + * The IVI test_setting settings plugin uses these macros to + * export the settings plugin API from the plugin as needed. + * + * @author Ossama Othman @<ossama.othman@@intel.com@> + * + * @copyright @par + * Copyright 2013 Intel Corporation All Rights Reserved. + * @par + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; + * version 2.1 of the License. + * @par + * This library 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 + * Lesser General Public License for more details. + * @par + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301 USA + */ + + +#ifndef TEST_SETTING_API_HPP +#define TEST_SETTING_API_HPP + +# if defined _WIN32 || defined __CYGWIN__ +# ifdef TEST_SETTING_BUILDING_DLL +# ifdef __GNUC__ +# define TEST_SETTING_API __attribute__ ((dllexport)) +# else +# define TEST_SETTING_API __declspec(dllexport) +# endif +# else +# ifdef __GNUC__ +# define TEST_SETTING_API __attribute__ ((dllimport)) +# else +# define TEST_SETTING_API __declspec(dllimport) +# endif +# endif +# define TEST_SETTING_LOCAL +# else +# if __GNUC__ >= 4 +# define TEST_SETTING_API __attribute__ ((visibility ("default"))) +# define TEST_SETTING_LOCAL __attribute__ ((visibility ("hidden"))) +# else +# define TEST_SETTING_API +# define TEST_SETTING_LOCAL +# endif +# endif + +#endif /* TEST_SETTING_API_HPP */ + + +// Local Variables: +// mode:c++ +// c-basic-offset:2 +// indent-tabs-mode: nil +// End: |