libindi_1.1.0/ 0000775 0001750 0001750 00000000000 12573036451 012175 5 ustar jasem jasem libindi_1.1.0/indiapi.h 0000664 0001750 0001750 00000036010 12573036357 013770 0 ustar jasem jasem #if 0
INDI
Copyright (C) 2003 Elwood C. Downey
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
#endif
#ifndef INDI_API_H
#define INDI_API_H
/** \mainpage Instrument Neutral Distributed Interface INDI
*
\section Introduction
INDI is a simple XML-like communications protocol described for interactive and automated remote control of diverse instrumentation.\n
INDI is small, easy to parse, and stateless. In the INDI paradigm each Device poses all command and status functions in terms of settings and getting Properties. Each Property is a vector of one or more names members. Each property has a current value vector; a target value vector; provides information about how it should be sequenced with respect to other Properties to accomplish one coordinated unit of observation; and provides hints as to how it might be displayed for interactive manipulation in a GUI.\n
Clients learn the Properties of a particular Device at runtime using introspection. This decouples Client and Device implementation histories. Devices have a complete authority over whether to accept commands from Clients. INDI accommadates intermediate servers, broadcasting, and connection topologies ranging from one-to-one on a single system to many-to-many between systems of different genre.\n
The INDI protocol can be nested within other XML elements such as constraints for automatic scheduling and execution.\n
For a complete review on the INDI protocol, please refer to the INDI white paper.
\section Audience Intended Audience
INDI is intended for developers who seek a scalable API for device control and automation. Hardware drivers written under INDI can be used under any INDI-compatible client. INDI serves as a backend only, you need frontend clients to control devices. Current clients include KStars, Xephem, DCD, and Cartes du Ciel.
\section Development Developing under INDI
Please refere to the INDI Developers Manual for a complete guide on INDI's driver developemnt framework.
The INDI Library API is divided into the following main sections:
\section Tutorials
INDI Library includes a number of tutorials to illustrate development of INDI drivers. Check out the examples provided with INDI library.
\section Simulators
Simulators provide a great framework to test drivers and equipment alike. INDI Library provides the following simulators:
Telescope Simulator: Offers GOTO capability, motion control, guiding, and ability to set Periodic Error (PE) which is read by the CCD simulator when generating images.
CCD Simulator: Offers a very flexible CCD simulator with a primary CCD chip and a guide chip. The simulator generate images based on the RA & DEC coordinates it
snoops from the telescope driver using General Star Catalog (GSC). Please note that you must install GSC for the CCD simulator to work properly. Furthermore,
The simulator snoops FWHM from the focuser simulator which affects the generated images focus. All images are generated in standard FITS format.
Filter Wheel Simulator: Offers a simple simulator to change filter wheels and their corresponding designations.
Focuser Simulator: Offers a simple simualtor for an absolute position focuser. It generates a simulated FWHM value that may be used by other simulator such as the CCD simulator.
Dome Simulator: Offers a simple simulator for an absolute position dome with shutter.
\section Help
You can find information on INDI development in the INDI Library site. Furthermore, you can discuss INDI related issues on the INDI development mailing list.
\author Jasem Mutlaq
\author Elwood Downey
*/
/** \file indiapi.h
\brief Constants and Data structure definitions for the interface to the reference INDI C API implementation.
\author Elwood C. Downey
*/
/*******************************************************************************
* INDI wire protocol version implemented by this API.
* N.B. this is indepedent of the API itself.
*/
#define INDIV 1.7
/* INDI Library version */
#define INDI_VERSION_MAJOR 1
#define INDI_VERSION_MINOR 1
#define INDI_VERSION_RELEASE 0
/*******************************************************************************
* Manifest constants
*/
/** \typedef ISState
\brief Switch state.
*/
typedef enum
{
ISS_OFF, /*!< Switch is OFF */
ISS_ON /*!< Switch is ON */
} ISState; /* switch state */
/** \typedef IPState
\brief Property state.
*/
typedef enum
{
IPS_IDLE, /*!< State is idle */
IPS_OK, /*!< State is ok */
IPS_BUSY, /*!< State is busy */
IPS_ALERT /*!< State is alert */
} IPState; /* property state */
/** \typedef ISRule
\brief Switch vector rule hint.
*/
typedef enum
{
ISR_1OFMANY, /*!< Only 1 switch of many can be ON (e.g. radio buttons) */
ISR_ATMOST1, /*!< At most one switch can be ON, but all switches can be off. It is similar to ISR_1OFMANY with the exception that all switches can be off. */
ISR_NOFMANY /*!< Any number of switches can be ON (e.g. check boxes) */
} ISRule; /* switch vector rule hint */
/** \typedef IPerm
\brief Permission hint, with respect to client.
*/
typedef enum
{
IP_RO, /*!< Read Only */
IP_WO, /*!< Write Only */
IP_RW /*!< Read & Write */
} IPerm; /* permission hint, WRT client */
/* The XML strings for these attributes may be any length but implementations
* are only obligued to support these lengths for the various string attributes.
*/
#define MAXINDINAME 64
#define MAXINDILABEL 64
#define MAXINDIDEVICE 64
#define MAXINDIGROUP 64
#define MAXINDIFORMAT 64
#define MAXINDIBLOBFMT 64
#define MAXINDITSTAMP 64
/*******************************************************************************
* Typedefs for each INDI Property type.
*
* INumber.format may be any printf-style appropriate for double
* or style "m" to create sexigesimal using the form "%.m" where
* is the total field width.
* is the width of the fraction. valid values are:
* 9 -> :mm:ss.ss
* 8 -> :mm:ss.s
* 6 -> :mm:ss
* 5 -> :mm.m
* 3 -> :mm
*
* examples:
*
* to produce use
*
* "-123:45" %7.3m
* " 0:01:02" %9.6m
*/
/** \struct IText
\brief One text descriptor.
*/
typedef struct {
/** index name */
char name[MAXINDINAME];
/** short description */
char label[MAXINDILABEL];
/** malloced text string */
char *text;
/** pointer to parent */
struct _ITextVectorProperty *tvp;
/** handy place to hang helper info */
void *aux0;
/** handy place to hang helper info */
void *aux1;
} IText;
/** \struct _ITextVectorProperty
\brief Text vector property descriptor.
*/
typedef struct _ITextVectorProperty {
/** device name */
char device[MAXINDIDEVICE];
/** property name */
char name[MAXINDINAME];
/** short description */
char label[MAXINDILABEL];
/** GUI grouping hint */
char group[MAXINDIGROUP];
/** client accessibility hint */
IPerm p;
/** current max time to change, secs */
double timeout;
/** current property state */
IPState s;
/** texts comprising this vector */
IText *tp;
/** dimension of tp[] */
int ntp;
/** ISO 8601 timestamp of this event */
char timestamp[MAXINDITSTAMP];
/** handy place to hang helper info */
void *aux;
} ITextVectorProperty;
/** \struct INumber
\brief One number descriptor.
*/
typedef struct {
char name[MAXINDINAME]; /** index name */
char label[MAXINDILABEL]; /** short description */
char format[MAXINDIFORMAT]; /** GUI display format, see above */
double min, max; /** range, ignore if min == max */
double step; /** step size, ignore if step == 0 */
double value; /** current value */
struct _INumberVectorProperty *nvp; /** pointer to parent */
void *aux0, *aux1; /** handy place to hang helper info */
} INumber;
/** \struct _INumberVectorProperty
\brief Number vector property descriptor.
INumber.format may be any printf-style appropriate for double or style "m" to create sexigesimal using the form "%\.\m" where:\n
\ is the total field width.\n
\ is the width of the fraction. valid values are:\n
9 -> \:mm:ss.ss \n
8 -> \:mm:ss.s \n
6 -> \:mm:ss \n
5 -> \:mm.m \n
3 -> \:mm \n
examples:\n
To produce "-123:45", use \%7.3m \n
To produce " 0:01:02", use \%9.6m
*/
typedef struct _INumberVectorProperty {
/** device name */
char device[MAXINDIDEVICE];
/** property name */
char name[MAXINDINAME];
/** short description */
char label[MAXINDILABEL];
/** GUI grouping hint */
char group[MAXINDIGROUP];
/** client accessibility hint */
IPerm p;
/** current max time to change, secs */
double timeout;
/** current property state */
IPState s;
/** numbers comprising this vector */
INumber *np;
/** dimension of np[] */
int nnp;
/** ISO 8601 timestamp of this event */
char timestamp[MAXINDITSTAMP];
/** handy place to hang helper info */
void *aux;
} INumberVectorProperty;
/** \struct ISwitch
\brief One switch descriptor.
*/
typedef struct {
char name[MAXINDINAME]; /** index name */
char label[MAXINDILABEL]; /** this switch's label */
ISState s; /** this switch's state */
struct _ISwitchVectorProperty *svp; /** pointer to parent */
void *aux; /** handy place to hang helper info */
} ISwitch;
/** \struct _ISwitchVectorProperty
\brief Switch vector property descriptor.
*/
typedef struct _ISwitchVectorProperty {
/** device name */
char device[MAXINDIDEVICE];
/** property name */
char name[MAXINDINAME];
/** short description */
char label[MAXINDILABEL];
/** GUI grouping hint */
char group[MAXINDIGROUP];
/** client accessibility hint */
IPerm p;
/** switch behavior hint */
ISRule r;
/** current max time to change, secs */
double timeout;
/** current property state */
IPState s;
/** switches comprising this vector */
ISwitch *sp;
/** dimension of sp[] */
int nsp;
/** ISO 8601 timestamp of this event */
char timestamp[MAXINDITSTAMP];
/** handy place to hang helper info */
void *aux;
} ISwitchVectorProperty;
/** \struct ILight
\brief One light descriptor.
*/
typedef struct {
char name[MAXINDINAME]; /** index name */
char label[MAXINDILABEL]; /** this lights's label */
IPState s; /** this lights's state */
struct _ILightVectorProperty *lvp; /** pointer to parent */
void *aux; /** handy place to hang helper info */
} ILight;
/** \struct _ILightVectorProperty
\brief Light vector property descriptor.
*/
typedef struct _ILightVectorProperty {
/** device name */
char device[MAXINDIDEVICE];
/** property name */
char name[MAXINDINAME];
/** short description */
char label[MAXINDILABEL];
/** GUI grouping hint */
char group[MAXINDIGROUP];
/** current property state */
IPState s;
/** lights comprising this vector */
ILight *lp;
/** dimension of lp[] */
int nlp;
/** ISO 8601 timestamp of this event */
char timestamp[MAXINDITSTAMP];
/** handy place to hang helper info */
void *aux;
} ILightVectorProperty;
/** \struct IBLOB
\brief One Blob (Binary Large Object) descriptor.
*/
typedef struct { /* one BLOB descriptor */
/** index name */
char name[MAXINDINAME];
/** this BLOB's label */
char label[MAXINDILABEL];
/** format attr */
char format[MAXINDIBLOBFMT];
/** malloced binary large object bytes */
void *blob;
/** bytes in blob */
int bloblen;
/** n uncompressed bytes */
int size;
/** pointer to parent */
struct _IBLOBVectorProperty *bvp;
/** handy place to hang helper info */
void *aux0, *aux1, *aux2;
} IBLOB;
/** \struct _IBLOBVectorProperty
\brief BLOB (Binary Large Object) vector property descriptor.
*/
typedef struct _IBLOBVectorProperty { /* BLOB vector property descriptor */
/** device name */
char device[MAXINDIDEVICE];
/** property name */
char name[MAXINDINAME];
/** short description */
char label[MAXINDILABEL];
/** GUI grouping hint */
char group[MAXINDIGROUP];
/** client accessibility hint */
IPerm p;
/** current max time to change, secs */
double timeout;
/** current property state */
IPState s;
/** BLOBs comprising this vector */
IBLOB *bp;
/** dimension of bp[] */
int nbp;
/** ISO 8601 timestamp of this event */
char timestamp[MAXINDITSTAMP];
/** handy place to hang helper info */
void *aux;
} IBLOBVectorProperty;
/** \brief Handy macro to find the number of elements in array a[]. Must be used with actual array, not pointer.
*/
#define NARRAY(a) (sizeof(a)/sizeof(a[0]))
#endif
libindi_1.1.0/TODO 0000664 0001750 0001750 00000000171 12573036357 012671 0 ustar jasem jasem TODO:
- RTML Support
- Multi user Scheduler daemon
- Web interface
- Vantage Pro/Pro2 Weather Station
- More Devices!
libindi_1.1.0/COPYING.GPL 0000664 0001750 0001750 00000043254 12573036357 013666 0 ustar jasem jasem GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 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.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, 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 or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
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 give any other recipients of the Program a copy of this License
along with the Program.
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 Program or any portion
of it, thus forming a work based on the Program, 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) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
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 Program, 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 Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) 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; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, 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 executable. However, as a
special exception, the source code 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.
If distribution of executable or 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 counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program 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.
5. 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 Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program 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 to
this License.
7. 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 Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program 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 Program.
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.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program 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.
9. The Free Software Foundation may publish revised and/or new versions
of the 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 Program
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 Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, 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
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "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 PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. 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 PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), 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 Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. 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.
Copyright (C)
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.
libindi_1.1.0/indidriver.c 0000664 0001750 0001750 00000154344 12573036357 014520 0 ustar jasem jasem #if 0
INDI Driver Functions
Copyright (C) 2003-2015 Jasem Mutlaq
Copyright (C) 2003-2006 Elwood C. Downey
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
#endif
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include "lilxml.h"
#include "base64.h"
#include "eventloop.h"
#include "indidevapi.h"
#include "indicom.h"
#include "indidriver.h"
pthread_mutex_t stdout_mutex = PTHREAD_MUTEX_INITIALIZER;
#define MAXRBUF 2048
/* output a string expanding special characters into xml/html escape sequences */
/* N.B. You must free the returned buffer after use! */
char * escapeXML(const char *s, unsigned int MAX_BUF_SIZE)
{
char *buf = malloc(sizeof(char)*MAX_BUF_SIZE);
char *out = buf;
unsigned int i=0;
for (i=0; i <= strlen(s); i++)
{
switch (s[i])
{
case '&':
strncpy(out, "&", 5);
out+=5;
break;
case '\'':
strncpy(out, "'", 6);
out+=6;
break;
case '"':
strncpy(out, """, 6);
out+=6;
break;
case '<':
strncpy(out, "<", 4);
out+=4;
break;
case '>':
strncpy(out, ">", 4);
out+=4;
break;
default:
strncpy(out++, s+i, 1);
break;
}
}
return buf;
}
/* tell Client to delete the property with given name on given device, or
* entire device if !name
*/
void
IDDelete (const char *dev, const char *name, const char *fmt, ...)
{
pthread_mutex_lock(&stdout_mutex);
xmlv1();
printf ("\n");
fflush (stdout);
pthread_mutex_unlock(&stdout_mutex);
}
/* tell indiserver we want to snoop on the given device/property.
* name ignored if NULL or empty.
*/
void
IDSnoopDevice (const char *snooped_device_name, const char *snooped_property_name)
{
pthread_mutex_lock(&stdout_mutex);
xmlv1();
if (snooped_property_name && snooped_property_name[0])
printf ("\n",
snooped_device_name, snooped_property_name);
else
printf ("\n", snooped_device_name);
fflush (stdout);
pthread_mutex_unlock(&stdout_mutex);
}
/* tell indiserver whether we want BLOBs from the given snooped device.
* silently ignored if given device is not already registered for snooping.
*/
void
IDSnoopBLOBs (const char *snooped_device, BLOBHandling bh)
{
const char *how;
switch (bh) {
case B_NEVER: how = "Never"; break;
case B_ALSO: how = "Also"; break;
case B_ONLY: how = "Only"; break;
default: return;
}
pthread_mutex_lock(&stdout_mutex);
xmlv1();
printf ("%s\n",
snooped_device, how);
fflush (stdout);
pthread_mutex_unlock(&stdout_mutex);
}
/* "INDI" wrappers to the more generic eventloop facility. */
int
IEAddCallback (int readfiledes, IE_CBF *fp, void *p)
{
return (addCallback (readfiledes, (CBF*)fp, p));
}
void
IERmCallback (int callbackid)
{
rmCallback (callbackid);
}
int
IEAddTimer (int millisecs, IE_TCF *fp, void *p)
{
return (addTimer (millisecs, (TCF*)fp, p));
}
void
IERmTimer (int timerid)
{
rmTimer (timerid);
}
int
IEAddWorkProc (IE_WPF *fp, void *p)
{
return (addWorkProc ((WPF*)fp, p));
}
void
IERmWorkProc (int workprocid)
{
rmWorkProc (workprocid);
}
int
IEDeferLoop (int maxms, int *flagp)
{
return (deferLoop (maxms, flagp));
}
int
IEDeferLoop0 (int maxms, int *flagp)
{
return (deferLoop0 (maxms, flagp));
}
/* Update property switches in accord with states and names. */
int
IUUpdateSwitch(ISwitchVectorProperty *svp, ISState *states, char *names[], int n)
{
int i=0;
ISwitch *sp;
char sn[MAXINDINAME];
/* store On switch name */
if (svp->r == ISR_1OFMANY)
{
sp = IUFindOnSwitch(svp);
if (sp) strncpy(sn, sp->name, MAXINDINAME);
IUResetSwitch(svp);
}
for (i = 0; i < n ; i++)
{
sp = IUFindSwitch(svp, names[i]);
if (!sp)
{
svp->s = IPS_IDLE;
IDSetSwitch(svp, "Error: %s is not a member of %s property.", names[i], svp->name);
return -1;
}
sp->s = states[i];
}
/* Consistency checks for ISR_1OFMANY after update. */
if (svp->r == ISR_1OFMANY)
{
int t_count=0;
for (i=0; i < svp->nsp; i++)
{
if (svp->sp[i].s == ISS_ON)
t_count++;
}
if (t_count != 1)
{
IUResetSwitch(svp);
sp = IUFindSwitch(svp, sn);
if (sp) sp->s = ISS_ON;
svp->s = IPS_IDLE;
IDSetSwitch(svp, "Error: invalid state switch for property %s. %s.", svp->name, t_count == 0 ? "No switch is on" : "Too many switches are on");
return -1;
}
}
return 0;
}
/* Update property numbers in accord with values and names */
int IUUpdateNumber(INumberVectorProperty *nvp, double values[], char *names[], int n)
{
int i=0;
INumber *np;
for (i = 0; i < n; i++)
{
np = IUFindNumber(nvp, names[i]);
if (!np)
{
nvp->s = IPS_IDLE;
IDSetNumber(nvp, "Error: %s is not a member of %s property.", names[i], nvp->name);
return -1;
}
if (values[i] < np->min || values[i] > np->max)
{
nvp->s = IPS_ALERT;
IDSetNumber(nvp, "Error: Invalid range for %s. Valid range is from %g to %g. Requested value is %g", np->name, np->min, np->max, values[i]);
return -1;
}
}
/* First loop checks for error, second loop set all values atomically*/
for (i=0; i < n; i++)
{
np = IUFindNumber(nvp, names[i]);
np->value = values[i];
}
return 0;
}
/* Update property text in accord with texts and names */
int IUUpdateText(ITextVectorProperty *tvp, char * texts[], char *names[], int n)
{
int i=0;
IText *tp;
for (i = 0; i < n; i++)
{
tp = IUFindText(tvp, names[i]);
if (!tp)
{
tvp->s = IPS_IDLE;
IDSetText(tvp, "Error: %s is not a member of %s property.", names[i], tvp->name);
return -1;
}
}
/* First loop checks for error, second loop set all values atomically*/
for (i=0; i < n; i++)
{
tp = IUFindText(tvp, names[i]);
IUSaveText(tp, texts[i]);
}
return 0;
}
/* Update property BLOB in accord with BLOBs and names */
int IUUpdateBLOB(IBLOBVectorProperty *bvp, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
{
int i=0;
IBLOB *bp;
for (i = 0; i < n; i++)
{
bp = IUFindBLOB(bvp, names[i]);
if (!bp)
{
bvp->s = IPS_IDLE;
IDSetBLOB(bvp, "Error: %s is not a member of %s property.", names[i], bvp->name);
return -1;
}
}
/* First loop checks for error, second loop set all values atomically*/
for (i=0; i < n; i++)
{
bp = IUFindBLOB(bvp, names[i]);
IUSaveBLOB(bp, sizes[i], blobsizes[i], blobs[i], formats[i]);
}
return 0;
}
int IUSaveBLOB(IBLOB *bp, int size, int blobsize, char *blob, char *format)
{
bp->bloblen = blobsize;
bp->size = size;
bp->blob = blob;
strncpy(bp->format, format, MAXINDIFORMAT);
return 0;
}
void IUFillSwitch(ISwitch *sp, const char *name, const char * label, ISState s)
{
char *escapedName = escapeXML(name, MAXINDINAME);
char *escapedLabel = escapeXML(label, MAXINDILABEL);
strncpy(sp->name, escapedName, MAXINDINAME);
strncpy(sp->label, escapedLabel, MAXINDILABEL);
sp->s = s;
sp->svp = NULL;
sp->aux = NULL;
free(escapedName);
free(escapedLabel);
}
void IUFillLight(ILight *lp, const char *name, const char * label, IPState s)
{
char *escapedName = escapeXML(name, MAXINDINAME);
char *escapedLabel = escapeXML(label, MAXINDILABEL);
strncpy(lp->name, escapedName, MAXINDINAME);
strncpy(lp->label, escapedLabel, MAXINDILABEL);
lp->s = s;
lp->lvp = NULL;
lp->aux = NULL;
free(escapedName);
free(escapedLabel);
}
void IUFillNumber(INumber *np, const char *name, const char * label, const char *format, double min, double max, double step, double value)
{
char *escapedName = escapeXML(name, MAXINDINAME);
char *escapedLabel = escapeXML(label, MAXINDILABEL);
strncpy(np->name, escapedName, MAXINDINAME);
strncpy(np->label, escapedLabel, MAXINDILABEL);
strncpy(np->format, format, MAXINDIFORMAT);
np->min = min;
np->max = max;
np->step = step;
np->value = value;
np->nvp = NULL;
np->aux0 = NULL;
np->aux1 = NULL;
free(escapedName);
free(escapedLabel);
}
void IUFillText(IText *tp, const char *name, const char * label, const char *initialText)
{
char *escapedName = escapeXML(name, MAXINDINAME);
char *escapedLabel = escapeXML(label, MAXINDILABEL);
strncpy(tp->name, escapedName, MAXINDINAME);
strncpy(tp->label, escapedLabel, MAXINDILABEL);
tp->text = NULL;
tp->tvp = NULL;
tp->aux0 = NULL;
tp->aux1 = NULL;
if (initialText && strlen(initialText) > 0)
IUSaveText(tp, initialText);
free(escapedName);
free(escapedLabel);
}
void IUFillBLOB(IBLOB *bp, const char *name, const char * label, const char *format)
{
char *escapedName = escapeXML(name, MAXINDINAME);
char *escapedLabel = escapeXML(label, MAXINDILABEL);
memset(bp, 0, sizeof(IBLOB));
strncpy(bp->name, escapedName, MAXINDINAME);
strncpy(bp->label, escapedLabel, MAXINDILABEL);
strncpy(bp->format, format, MAXINDIBLOBFMT);
bp->blob = 0;
bp->bloblen = 0;
bp->size = 0;
bp->bvp = 0;
bp->aux0 = 0;
bp->aux1 = 0;
bp->aux2 = 0;
free(escapedName);
free(escapedLabel);
}
void IUFillSwitchVector(ISwitchVectorProperty *svp, ISwitch *sp, int nsp, const char * dev, const char *name, const char *label, const char *group, IPerm p, ISRule r, double timeout, IPState s)
{
char *escapedName = escapeXML(name, MAXINDINAME);
char *escapedLabel = escapeXML(label, MAXINDILABEL);
strncpy(svp->device, dev, MAXINDIDEVICE);
strncpy(svp->name, escapedName, MAXINDINAME);
strncpy(svp->label, escapedLabel, MAXINDILABEL);
strncpy(svp->group, group, MAXINDIGROUP);
strcpy(svp->timestamp, "");
svp->p = p;
svp->r = r;
svp->timeout = timeout;
svp->s = s;
svp->sp = sp;
svp->nsp = nsp;
free(escapedName);
free(escapedLabel);
}
void IUFillLightVector(ILightVectorProperty *lvp, ILight *lp, int nlp, const char * dev, const char *name, const char *label, const char *group, IPState s)
{
char *escapedName = escapeXML(name, MAXINDINAME);
char *escapedLabel = escapeXML(label, MAXINDILABEL);
strncpy(lvp->device, dev, MAXINDIDEVICE);
strncpy(lvp->name, escapedName, MAXINDINAME);
strncpy(lvp->label, escapedLabel, MAXINDILABEL);
strncpy(lvp->group, group, MAXINDIGROUP);
strcpy(lvp->timestamp, "");
lvp->s = s;
lvp->lp = lp;
lvp->nlp = nlp;
free(escapedName);
free(escapedLabel);
}
void IUFillNumberVector(INumberVectorProperty *nvp, INumber *np, int nnp, const char * dev, const char *name, const char *label, const char* group, IPerm p, double timeout, IPState s)
{
char *escapedName = escapeXML(name, MAXINDINAME);
char *escapedLabel = escapeXML(label, MAXINDILABEL);
strncpy(nvp->device, dev, MAXINDIDEVICE);
strncpy(nvp->name, escapedName, MAXINDINAME);
strncpy(nvp->label, escapedLabel, MAXINDILABEL);
strncpy(nvp->group, group, MAXINDIGROUP);
strcpy(nvp->timestamp, "");
nvp->p = p;
nvp->timeout = timeout;
nvp->s = s;
nvp->np = np;
nvp->nnp = nnp;
free(escapedName);
free(escapedLabel);
}
void IUFillTextVector(ITextVectorProperty *tvp, IText *tp, int ntp, const char * dev, const char *name, const char *label, const char* group, IPerm p, double timeout, IPState s)
{
char *escapedName = escapeXML(name, MAXINDINAME);
char *escapedLabel = escapeXML(label, MAXINDILABEL);
strncpy(tvp->device, dev, MAXINDIDEVICE);
strncpy(tvp->name, escapedName, MAXINDINAME);
strncpy(tvp->label, escapedLabel, MAXINDILABEL);
strncpy(tvp->group, group, MAXINDIGROUP);
strcpy(tvp->timestamp, "");
tvp->p = p;
tvp->timeout = timeout;
tvp->s = s;
tvp->tp = tp;
tvp->ntp = ntp;
free(escapedName);
free(escapedLabel);
}
void IUFillBLOBVector(IBLOBVectorProperty *bvp, IBLOB *bp, int nbp, const char * dev, const char *name, const char *label, const char* group, IPerm p, double timeout, IPState s)
{
char *escapedName = escapeXML(name, MAXINDINAME);
char *escapedLabel = escapeXML(label, MAXINDILABEL);
memset(bvp, 0, sizeof(IBLOBVectorProperty));
strncpy(bvp->device, dev, MAXINDIDEVICE);
strncpy(bvp->name, escapedName, MAXINDINAME);
strncpy(bvp->label, escapedLabel, MAXINDILABEL);
strncpy(bvp->group, group, MAXINDIGROUP);
strcpy(bvp->timestamp, "");
bvp->p = p;
bvp->timeout = timeout;
bvp->s = s;
bvp->bp = bp;
bvp->nbp = nbp;
free(escapedName);
free(escapedLabel);
}
/*****************************************************************************
* convenience functions for use in your implementation of ISSnoopDevice().
*/
/* crack the snooped driver setNumberVector or defNumberVector message into
* the given INumberVectorProperty.
* return 0 if type, device and name match and all members are present, else
* return -1
*/
int
IUSnoopNumber (XMLEle *root, INumberVectorProperty *nvp)
{
char *dev, *name;
XMLEle *ep;
int i;
/* check and crack type, device, name and state */
if (strcmp (tagXMLEle(root)+3, "NumberVector") ||
crackDN (root, &dev, &name, NULL) < 0)
return (-1);
if (strcmp (dev, nvp->device) || strcmp (name, nvp->name))
return (-1); /* not this property */
(void) crackIPState (findXMLAttValu (root,"state"), &nvp->s);
/* match each INumber with a oneNumber */
setlocale(LC_NUMERIC,"C");
for (i = 0; i < nvp->nnp; i++) {
for (ep = nextXMLEle(root,1); ep; ep = nextXMLEle(root,0)) {
if (!strcmp (tagXMLEle(ep)+3, "Number") &&
!strcmp (nvp->np[i].name, findXMLAttValu(ep, "name"))) {
if (f_scansexa (pcdataXMLEle(ep), &nvp->np[i].value) < 0) {
setlocale(LC_NUMERIC,"");
return (-1); /* bad number format */
}
break;
}
}
if (!ep) {
setlocale(LC_NUMERIC,"");
return (-1); /* element not found */
}
}
setlocale(LC_NUMERIC,"");
/* ok */
return (0);
}
/* crack the snooped driver setTextVector or defTextVector message into
* the given ITextVectorProperty.
* return 0 if type, device and name match and all members are present, else
* return -1
*/
int
IUSnoopText (XMLEle *root, ITextVectorProperty *tvp)
{
char *dev, *name;
XMLEle *ep;
int i;
/* check and crack type, device, name and state */
if (strcmp (tagXMLEle(root)+3, "TextVector") ||
crackDN (root, &dev, &name, NULL) < 0)
return (-1);
if (strcmp (dev, tvp->device) || strcmp (name, tvp->name))
return (-1); /* not this property */
(void) crackIPState (findXMLAttValu (root,"state"), &tvp->s);
/* match each IText with a oneText */
for (i = 0; i < tvp->ntp; i++) {
for (ep = nextXMLEle(root,1); ep; ep = nextXMLEle(root,0)) {
if (!strcmp (tagXMLEle(ep)+3, "Text") &&
!strcmp (tvp->tp[i].name, findXMLAttValu(ep, "name"))) {
IUSaveText (&tvp->tp[i], pcdataXMLEle(ep));
break;
}
}
if (!ep)
return (-1); /* element not found */
}
/* ok */
return (0);
}
/* crack the snooped driver setLightVector or defLightVector message into
* the given ILightVectorProperty. it is not necessary that all ILight names
* be found.
* return 0 if type, device and name match, else return -1.
*/
int
IUSnoopLight (XMLEle *root, ILightVectorProperty *lvp)
{
char *dev, *name;
XMLEle *ep;
int i;
/* check and crack type, device, name and state */
if (strcmp (tagXMLEle(root)+3, "LightVector") ||
crackDN (root, &dev, &name, NULL) < 0)
return (-1);
if (strcmp (dev, lvp->device) || strcmp (name, lvp->name))
return (-1); /* not this property */
(void) crackIPState (findXMLAttValu (root,"state"), &lvp->s);
/* match each oneLight with one ILight */
for (ep = nextXMLEle(root,1); ep; ep = nextXMLEle(root,0)) {
if (!strcmp (tagXMLEle(ep)+3, "Light")) {
const char *name = findXMLAttValu (ep, "name");
for (i = 0; i < lvp->nlp; i++) {
if (!strcmp (lvp->lp[i].name, name)) {
if (crackIPState(pcdataXMLEle(ep), &lvp->lp[i].s) < 0) {
return (-1); /* unrecognized state */
}
break;
}
}
}
}
/* ok */
return (0);
}
/* crack the snooped driver setSwitchVector or defSwitchVector message into the
* given ISwitchVectorProperty. it is not necessary that all ISwitch names be
* found.
* return 0 if type, device and name match, else return -1.
*/
int
IUSnoopSwitch (XMLEle *root, ISwitchVectorProperty *svp)
{
char *dev, *name;
XMLEle *ep;
int i;
/* check and crack type, device, name and state */
if (strcmp (tagXMLEle(root)+3, "SwitchVector") ||
crackDN (root, &dev, &name, NULL) < 0)
return (-1);
if (strcmp (dev, svp->device) || strcmp (name, svp->name))
return (-1); /* not this property */
(void) crackIPState (findXMLAttValu (root,"state"), &svp->s);
/* match each oneSwitch with one ISwitch */
for (ep = nextXMLEle(root,1); ep; ep = nextXMLEle(root,0)) {
if (!strcmp (tagXMLEle(ep)+3, "Switch")) {
const char *name = findXMLAttValu (ep, "name");
for (i = 0; i < svp->nsp; i++) {
if (!strcmp (svp->sp[i].name, name)) {
if (crackISState(pcdataXMLEle(ep), &svp->sp[i].s) < 0) {
return (-1); /* unrecognized state */
}
break;
}
}
}
}
/* ok */
return (0);
}
/* crack the snooped driver setBLOBVector message into the given
* IBLOBVectorProperty. it is not necessary that all IBLOB names be found.
* return 0 if type, device and name match, else return -1.
* N.B. we assume any existing blob in bvp has been malloced, which we free
* and replace with a newly malloced blob if found.
*/
int
IUSnoopBLOB (XMLEle *root, IBLOBVectorProperty *bvp)
{
char *dev, *name;
XMLEle *ep;
int i;
/* check and crack type, device, name and state */
if (strcmp (tagXMLEle(root), "setBLOBVector") ||
crackDN (root, &dev, &name, NULL) < 0)
return (-1);
if (strcmp (dev, bvp->device) || strcmp (name, bvp->name))
return (-1); /* not this property */
(void) crackIPState (findXMLAttValu (root,"state"), &bvp->s);
/* match each oneBLOB with one IBLOB */
for (ep = nextXMLEle(root,1); ep; ep = nextXMLEle(root,0)) {
if (!strcmp (tagXMLEle(ep)+3, "BLOB")) {
const char *name = findXMLAttValu (ep, "name");
for (i = 0; i < bvp->nbp; i++) {
IBLOB *bp = &bvp->bp[i];
if (!strcmp (bp->name, name)) {
strcpy (bp->format, findXMLAttValu (ep,"format"));
bp->size = atof (findXMLAttValu (ep,"size"));
bp->bloblen = pcdatalenXMLEle(ep)+1;
if (bp->blob)
free (bp->blob);
bp->blob = strcpy(malloc(bp->bloblen),pcdataXMLEle(ep));
break;
}
}
}
}
/* ok */
return (0);
}
/* callback when INDI client message arrives on stdin.
* collect and dispatch when see outter element closure.
* exit if OS trouble or see incompatable INDI version.
* arg is not used.
*/
void
clientMsgCB (int fd, void *arg)
{
char buf[1024], msg[1024], *bp;
int nr;
arg=arg;
/* one read */
nr = read (fd, buf, sizeof(buf));
if (nr < 0) {
fprintf (stderr, "%s: %s\n", me, strerror(errno));
exit(1);
}
if (nr == 0) {
fprintf (stderr, "%s: EOF\n", me);
exit(1);
}
/* crack and dispatch when complete */
for (bp = buf; nr-- > 0; bp++) {
XMLEle *root = readXMLEle (clixml, *bp, msg);
if (root) {
if (dispatch (root, msg) < 0)
fprintf (stderr, "%s dispatch error: %s\n", me, msg);
delXMLEle (root);
} else if (msg[0])
fprintf (stderr, "%s XML error: %s\n", me, msg);
}
}
/* crack the given INDI XML element and call driver's IS* entry points as they
* are recognized.
* return 0 if ok else -1 with reason in msg[].
* N.B. exit if getProperties does not proclaim a compatible version.
*/
int
dispatch (XMLEle *root, char msg[])
{
char *rtag = tagXMLEle(root);
XMLEle *ep;
int n,i=0;
if (verbose)
prXMLEle (stderr, root, 0);
/* check tag in surmised decreasing order of likelyhood */
if (!strcmp (rtag, "newNumberVector")) {
static double *doubles;
static char **names;
static int maxn;
char *dev, *name;
/* pull out device and name */
if (crackDN (root, &dev, &name, msg) < 0)
return (-1);
if (!isPropDefined(name))
return -1;
/* ensure property is not RO */
for (i=0; i < nroCheck; i++)
{
if (!strcmp(roCheck[i].propName, name))
{
if (roCheck[i].perm == IP_RO)
return -1;
else
break;
}
}
/* seed for reallocs */
if (!doubles) {
doubles = (double *) malloc (1);
names = (char **) malloc (1);
}
/* pull out each name/value pair */
setlocale(LC_NUMERIC,"C");
for (n = 0, ep = nextXMLEle(root,1); ep; ep = nextXMLEle(root,0)) {
if (strcmp (tagXMLEle(ep), "oneNumber") == 0) {
XMLAtt *na = findXMLAtt (ep, "name");
if (na) {
if (n >= maxn) {
/* grow for this and another */
int newsz = (maxn=n+1)*sizeof(double);
doubles = (double *) realloc(doubles,newsz);
newsz = maxn*sizeof(char *);
names = (char **) realloc (names, newsz);
}
if (f_scansexa (pcdataXMLEle(ep), &doubles[n]) < 0)
IDMessage (dev,"%s: Bad format %s", name,
pcdataXMLEle(ep));
else
names[n++] = valuXMLAtt(na);
}
}
}
setlocale(LC_NUMERIC,"");
/* invoke driver if something to do, but not an error if not */
if (n > 0)
ISNewNumber (dev, name, doubles, names, n);
else
IDMessage(dev,"%s: newNumberVector with no valid members",name);
return (0);
}
if (!strcmp (rtag, "newSwitchVector")) {
static ISState *states;
static char **names;
static int maxn;
char *dev, *name;
XMLEle *ep;
/* pull out device and name */
if (crackDN (root, &dev, &name, msg) < 0)
return (-1);
if (!isPropDefined(name))
return -1;
/* ensure property is not RO */
for (i=0; i < nroCheck; i++)
{
if (!strcmp(roCheck[i].propName, name))
{
if (roCheck[i].perm == IP_RO)
return -1;
else
break;
}
}
/* seed for reallocs */
if (!states) {
states = (ISState *) malloc (1);
names = (char **) malloc (1);
}
/* pull out each name/state pair */
for (n = 0, ep = nextXMLEle(root,1); ep; ep = nextXMLEle(root,0)) {
if (strcmp (tagXMLEle(ep), "oneSwitch") == 0) {
XMLAtt *na = findXMLAtt (ep, "name");
if (na) {
if (n >= maxn) {
int newsz = (maxn=n+1)*sizeof(ISState);
states = (ISState *) realloc(states, newsz);
newsz = maxn*sizeof(char *);
names = (char **) realloc (names, newsz);
}
if (strcmp (pcdataXMLEle(ep),"On") == 0) {
states[n] = ISS_ON;
names[n] = valuXMLAtt(na);
n++;
} else if (strcmp (pcdataXMLEle(ep),"Off") == 0) {
states[n] = ISS_OFF;
names[n] = valuXMLAtt(na);
n++;
} else
IDMessage (dev, "%s: must be On or Off: %s", name,
pcdataXMLEle(ep));
}
}
}
/* invoke driver if something to do, but not an error if not */
if (n > 0)
ISNewSwitch (dev, name, states, names, n);
else
IDMessage(dev,"%s: newSwitchVector with no valid members",name);
return (0);
}
if (!strcmp (rtag, "newTextVector")) {
static char **texts;
static char **names;
static int maxn;
char *dev, *name;
/* pull out device and name */
if (crackDN (root, &dev, &name, msg) < 0)
return (-1);
if (!isPropDefined(name))
return -1;
/* ensure property is not RO */
for (i=0; i < nroCheck; i++)
{
if (!strcmp(roCheck[i].propName, name))
{
if (roCheck[i].perm == IP_RO)
return -1;
else
break;
}
}
/* seed for reallocs */
if (!texts) {
texts = (char **) malloc (1);
names = (char **) malloc (1);
}
/* pull out each name/text pair */
for (n = 0, ep = nextXMLEle(root,1); ep; ep = nextXMLEle(root,0)) {
if (strcmp (tagXMLEle(ep), "oneText") == 0) {
XMLAtt *na = findXMLAtt (ep, "name");
if (na) {
if (n >= maxn) {
int newsz = (maxn=n+1)*sizeof(char *);
texts = (char **) realloc (texts, newsz);
names = (char **) realloc (names, newsz);
}
texts[n] = pcdataXMLEle(ep);
names[n] = valuXMLAtt(na);
n++;
}
}
}
/* invoke driver if something to do, but not an error if not */
if (n > 0)
ISNewText (dev, name, texts, names, n);
else
IDMessage (dev, "%s: set with no valid members", name);
return (0);
}
if (!strcmp (rtag, "newBLOBVector")) {
static char **blobs;
static char **names;
static char **formats;
static int *blobsizes;
static int *sizes;
static int maxn;
char *dev, *name;
int i;
/* pull out device and name */
if (crackDN (root, &dev, &name, msg) < 0)
return (-1);
if (!isPropDefined(name))
return -1;
/* seed for reallocs */
if (!blobs) {
blobs = (char **) malloc (1);
names = (char **) malloc (1);
formats = (char **) malloc (1);
blobsizes = (int *) malloc (1);
sizes = (int *) malloc (1);
}
/* pull out each name/BLOB pair, decode */
for (n = 0, ep = nextXMLEle(root,1); ep; ep = nextXMLEle(root,0)) {
if (strcmp (tagXMLEle(ep), "oneBLOB") == 0) {
XMLAtt *na = findXMLAtt (ep, "name");
XMLAtt *fa = findXMLAtt (ep, "format");
XMLAtt *sa = findXMLAtt (ep, "size");
if (na && fa && sa) {
if (n >= maxn) {
int newsz = (maxn=n+1)*sizeof(char *);
blobs = (char **) realloc (blobs, newsz);
names = (char **) realloc (names, newsz);
formats = (char **) realloc(formats,newsz);
newsz = maxn*sizeof(int);
sizes = (int *) realloc(sizes,newsz);
blobsizes = (int *) realloc(blobsizes,newsz);
}
blobs[n] = malloc (3*pcdatalenXMLEle(ep)/4);
blobsizes[n] = from64tobits(blobs[n], pcdataXMLEle(ep));
names[n] = valuXMLAtt(na);
formats[n] = valuXMLAtt(fa);
sizes[n] = atoi(valuXMLAtt(sa));
n++;
}
}
}
/* invoke driver if something to do, but not an error if not */
if (n > 0) {
ISNewBLOB (dev, name, sizes, blobsizes, blobs, formats,names,n);
for (i = 0; i < n; i++)
free (blobs[i]);
} else
IDMessage (dev, "%s: newBLOBVector with no valid members",name);
return (0);
}
if (!strcmp (rtag, "getProperties")) {
XMLAtt *ap;
double v;
/* check version */
ap = findXMLAtt (root, "version");
if (!ap) {
fprintf (stderr, "%s: getProperties missing version\n", me);
exit(1);
}
v = atof (valuXMLAtt(ap));
if (v > INDIV) {
fprintf (stderr, "%s: client version %g > %g\n", me, v, INDIV);
exit(1);
}
/* ok */
ap = findXMLAtt (root, "device");
ISGetProperties (ap ? valuXMLAtt(ap) : NULL);
return (0);
}
/* other commands might be from a snooped device.
* we don't know here which devices are being snooped so we send
* all remaining valid messages
*/
if ( !strcmp (rtag, "setNumberVector") ||
!strcmp (rtag, "setTextVector") ||
!strcmp (rtag, "setLightVector") ||
!strcmp (rtag, "setSwitchVector") ||
!strcmp (rtag, "setBLOBVector") ||
!strcmp (rtag, "defNumberVector") ||
!strcmp (rtag, "defTextVector") ||
!strcmp (rtag, "defLightVector") ||
!strcmp (rtag, "defSwitchVector") ||
!strcmp (rtag, "defBLOBVector") ||
!strcmp (rtag, "message") ||
!strcmp (rtag, "delProperty")) {
ISSnoopDevice (root);
return (0);
}
sprintf (msg, "Unknown command: %s", rtag);
return(1);
}
int IUReadConfig(const char *filename, const char *dev, const char *property, int silent, char errmsg[])
{
char configFileName[MAXRBUF];
char *rname, *rdev;
XMLEle *root = NULL, *fproot = NULL;
LilXML *lp = newLilXML();
FILE *fp = NULL;
if (filename)
strncpy(configFileName, filename, MAXRBUF);
else
{
if (getenv("INDICONFIG"))
strncpy(configFileName, getenv("INDICONFIG"), MAXRBUF);
else
snprintf(configFileName, MAXRBUF, "%s/.indi/%s_config.xml", getenv("HOME"), dev);
}
fp = fopen(configFileName, "r");
if (fp == NULL)
{
snprintf(errmsg, MAXRBUF, "Unable to read user config file. Error loading file %s: %s\n", configFileName, strerror(errno));
return -1;
}
fproot = readXMLFile(fp, lp, errmsg);
if (fproot == NULL)
{
snprintf(errmsg, MAXRBUF, "Unable to parse config XML: %s", errmsg);
fclose(fp);
return -1;
}
if (nXMLEle(fproot) > 0 && silent != 1)
IDMessage(dev, "Loading device configuration...");
for (root = nextXMLEle (fproot, 1); root != NULL; root = nextXMLEle (fproot, 0))
{
/* pull out device and name */
if (crackDN (root, &rdev, &rname, errmsg) < 0)
{
fclose(fp);
return -1;
}
// It doesn't belong to our device??
if (strcmp(dev, rdev))
continue;
if ( (property && !strcmp(property, rname)) || property == NULL)
dispatch(root, errmsg);
}
if (nXMLEle(fproot) > 0 && silent != 1)
IDMessage(dev, "Device configuration applied.");
fclose(fp);
delXMLEle(fproot);
delXMLEle(root);
delLilXML(lp);
return (0);
}
void IUSaveDefaultConfig(const char *source_config, const char *dest_config, const char *dev)
{
char configFileName[MAXRBUF], configDefaultFileName[MAXRBUF];
if (source_config)
strncpy(configFileName, source_config, MAXRBUF);
else
{
if (getenv("INDICONFIG"))
strncpy(configFileName, getenv("INDICONFIG"), MAXRBUF);
else
snprintf(configFileName, MAXRBUF, "%s/.indi/%s_config.xml", getenv("HOME"), dev);
}
if (dest_config)
strncpy(configDefaultFileName, dest_config, MAXRBUF);
else if (getenv("INDICONFIG"))
snprintf(configDefaultFileName, MAXRBUF, "%s.default", getenv("INDICONFIG"));
else
snprintf(configDefaultFileName, MAXRBUF, "%s/.indi/%s_config.xml.default", getenv("HOME"), dev);
// If the default doesn't exist, create it.
if (access(configDefaultFileName, F_OK))
{
FILE *fpin = fopen(configFileName, "r");
if(fpin != NULL)
{
FILE *fpout = fopen(configDefaultFileName, "w");
if(fpout != NULL)
{
int ch = 0;
while((ch = getc(fpin)) != EOF)
putc(ch, fpout);
fclose(fpin);
}
fclose(fpout);
}
}
}
/* send client a message for a specific device or at large if !dev */
void
IDMessage (const char *dev, const char *fmt, ...)
{
pthread_mutex_lock(&stdout_mutex);
xmlv1();
printf ("\n");
fflush (stdout);
pthread_mutex_unlock(&stdout_mutex);
}
FILE * IUGetConfigFP(const char *filename, const char *dev, char errmsg[])
{
char configFileName[MAXRBUF];
char configDir[MAXRBUF];
struct stat st;
FILE *fp = NULL;
snprintf(configDir, MAXRBUF, "%s/.indi/", getenv("HOME"));
if (filename)
strncpy(configFileName, filename, MAXRBUF);
else
{
if (getenv("INDICONFIG"))
strncpy(configFileName, getenv("INDICONFIG"), MAXRBUF);
else
snprintf(configFileName, MAXRBUF, "%s%s_config.xml", configDir, dev);
}
if(stat(configDir,&st) != 0)
{
if (mkdir(configDir, S_IRWXU|S_IRWXG|S_IROTH|S_IXOTH) < 0)
{
snprintf(errmsg, MAXRBUF, "Unable to create config directory. Error %s: %s\n", configDir, strerror(errno));
return NULL;
}
}
fp = fopen(configFileName, "w");
if (fp == NULL)
{
snprintf(errmsg, MAXRBUF, "Unable to open config file. Error loading file %s: %s\n", configFileName, strerror(errno));
return NULL;
}
return fp;
}
void IUSaveConfigTag(FILE *fp, int ctag, const char * dev, int silent)
{
if (!fp)
return;
/* Opening tag */
if (ctag == 0)
{
fprintf(fp, "\n");
if (silent != 1)
IDMessage(dev, "Saving device configuration...");
}
/* Closing tag */
else
{
fprintf(fp, "\n");
if (silent != 1)
IDMessage(dev, "Device configuration saved.");
}
}
void IUSaveConfigNumber (FILE *fp, const INumberVectorProperty *nvp)
{
int i;
setlocale(LC_NUMERIC,"C");
fprintf (fp, "\n", nvp->device, nvp->name);
for (i = 0; i < nvp->nnp; i++)
{
INumber *np = &nvp->np[i];
fprintf (fp, " \n", np->name);
fprintf (fp, " %.20g\n", np->value);
fprintf (fp, " \n");
}
fprintf (fp, "\n");
setlocale(LC_NUMERIC,"");
}
void IUSaveConfigText (FILE *fp, const ITextVectorProperty *tvp)
{
int i;
fprintf (fp, "\n", tvp->device, tvp->name);
for (i = 0; i < tvp->ntp; i++)
{
IText *tp = &tvp->tp[i];
fprintf (fp, " \n", tp->name);
fprintf (fp, " %s\n", tp->text ? tp->text : "");
fprintf (fp, " \n");
}
fprintf (fp, "\n");
}
void IUSaveConfigSwitch (FILE *fp, const ISwitchVectorProperty *svp)
{
int i;
fprintf (fp, "\n", svp->device, svp->name);
for (i = 0; i < svp->nsp; i++)
{
ISwitch *sp = &svp->sp[i];
fprintf (fp, " \n", sp->name);
fprintf (fp, " %s\n", sstateStr(sp->s));
fprintf (fp, " \n");
}
fprintf (fp, "\n");
}
void IUSaveConfigBLOB (FILE *fp, const IBLOBVectorProperty *bvp)
{
int i;
fprintf (fp, "\n", bvp->device, bvp->name);
for (i = 0; i < bvp->nbp; i++)
{
IBLOB *bp = &bvp->bp[i];
unsigned char *encblob;
int j, l;
fprintf (fp, " name);
fprintf (fp, " size='%d'\n", bp->size);
fprintf (fp, " format='%s'>\n", bp->format);
encblob = malloc (4*bp->bloblen/3+4);
l = to64frombits(encblob, bp->blob, bp->bloblen);
for (j = 0; j < l; j += 72)
fprintf (fp, "%.72s\n", encblob+j);
free (encblob);
fprintf (fp, " \n");
}
fprintf (fp, "\n");
}
/* tell client to create a text vector property */
void
IDDefText (const ITextVectorProperty *tvp, const char *fmt, ...)
{
int i;
ROSC *SC;
pthread_mutex_lock(&stdout_mutex);
xmlv1();
setlocale(LC_NUMERIC,"C");
printf ("device);
printf (" name='%s'\n", tvp->name);
printf (" label='%s'\n", tvp->label);
printf (" group='%s'\n", tvp->group);
printf (" state='%s'\n", pstateStr(tvp->s));
printf (" perm='%s'\n", permStr(tvp->p));
printf (" timeout='%g'\n", tvp->timeout);
printf (" timestamp='%s'\n", timestamp());
if (fmt) {
va_list ap;
va_start (ap, fmt);
printf (" message='");
vprintf (fmt, ap);
printf ("'\n");
va_end (ap);
}
printf (">\n");
for (i = 0; i < tvp->ntp; i++) {
IText *tp = &tvp->tp[i];
printf (" name);
printf (" label='%s'>\n", tp->label);
printf (" %s\n", tp->text ? tp->text : "");
printf (" \n");
}
printf ("\n");
if (!isPropDefined(tvp->name))
{
/* Add this property to insure proper sanity check */
roCheck = roCheck ? (ROSC *) realloc ( roCheck, sizeof(ROSC) * (nroCheck+1))
: (ROSC *) malloc ( sizeof(ROSC));
SC = &roCheck[nroCheck++];
strcpy(SC->propName, tvp->name);
SC->perm = tvp->p;
}
setlocale(LC_NUMERIC,"");
fflush (stdout);
pthread_mutex_unlock(&stdout_mutex);
}
/* tell client to create a new numeric vector property */
void
IDDefNumber (const INumberVectorProperty *n, const char *fmt, ...)
{
int i;
ROSC *SC;
pthread_mutex_lock(&stdout_mutex);
xmlv1();
setlocale(LC_NUMERIC,"C");
printf ("device);
printf (" name='%s'\n", n->name);
printf (" label='%s'\n", n->label);
printf (" group='%s'\n", n->group);
printf (" state='%s'\n", pstateStr(n->s));
printf (" perm='%s'\n", permStr(n->p));
printf (" timeout='%g'\n", n->timeout);
printf (" timestamp='%s'\n", timestamp());
if (fmt) {
va_list ap;
va_start (ap, fmt);
printf (" message='");
vprintf (fmt, ap);
printf ("'\n");
va_end (ap);
}
printf (">\n");
for (i = 0; i < n->nnp; i++) {
INumber *np = &n->np[i];
printf (" name);
printf (" label='%s'\n", np->label);
printf (" format='%s'\n", np->format);
printf (" min='%.20g'\n", np->min);
printf (" max='%.20g'\n", np->max);
printf (" step='%.20g'>\n", np->step);
printf (" %.20g\n", np->value);
printf (" \n");
}
printf ("\n");
if (!isPropDefined(n->name))
{
/* Add this property to insure proper sanity check */
roCheck = roCheck ? (ROSC *) realloc ( roCheck, sizeof(ROSC) * (nroCheck+1))
: (ROSC *) malloc ( sizeof(ROSC));
SC = &roCheck[nroCheck++];
strcpy(SC->propName, n->name);
SC->perm = n->p;
}
setlocale(LC_NUMERIC,"");
fflush (stdout);
pthread_mutex_unlock(&stdout_mutex);
}
/* tell client to create a new switch vector property */
void
IDDefSwitch (const ISwitchVectorProperty *s, const char *fmt, ...)
{
int i;
ROSC *SC;
pthread_mutex_lock(&stdout_mutex);
xmlv1();
setlocale(LC_NUMERIC,"C");
printf ("device);
printf (" name='%s'\n", s->name);
printf (" label='%s'\n", s->label);
printf (" group='%s'\n", s->group);
printf (" state='%s'\n", pstateStr(s->s));
printf (" perm='%s'\n", permStr(s->p));
printf (" rule='%s'\n", ruleStr (s->r));
printf (" timeout='%g'\n", s->timeout);
printf (" timestamp='%s'\n", timestamp());
if (fmt) {
va_list ap;
va_start (ap, fmt);
printf (" message='");
vprintf (fmt, ap);
printf ("'\n");
va_end (ap);
}
printf (">\n");
for (i = 0; i < s->nsp; i++) {
ISwitch *sp = &s->sp[i];
printf (" name);
printf (" label='%s'>\n", sp->label);
printf (" %s\n", sstateStr(sp->s));
printf (" \n");
}
printf ("\n");
if (!isPropDefined(s->name))
{
/* Add this property to insure proper sanity check */
roCheck = roCheck ? (ROSC *) realloc ( roCheck, sizeof(ROSC) * (nroCheck+1))
: (ROSC *) malloc ( sizeof(ROSC));
SC = &roCheck[nroCheck++];
strcpy(SC->propName, s->name);
SC->perm = s->p;
}
setlocale(LC_NUMERIC,"");
fflush (stdout);
pthread_mutex_unlock(&stdout_mutex);
}
/* tell client to create a new lights vector property */
void
IDDefLight (const ILightVectorProperty *lvp, const char *fmt, ...)
{
int i;
pthread_mutex_lock(&stdout_mutex);
xmlv1();
printf ("device);
printf (" name='%s'\n", lvp->name);
printf (" label='%s'\n", lvp->label);
printf (" group='%s'\n", lvp->group);
printf (" state='%s'\n", pstateStr(lvp->s));
printf (" timestamp='%s'\n", timestamp());
if (fmt) {
va_list ap;
va_start (ap, fmt);
printf (" message='");
vprintf (fmt, ap);
printf ("'\n");
va_end (ap);
}
printf (">\n");
for (i = 0; i < lvp->nlp; i++) {
ILight *lp = &lvp->lp[i];
printf (" name);
printf (" label='%s'>\n", lp->label);
printf (" %s\n", pstateStr(lp->s));
printf (" \n");
}
printf ("\n");
fflush (stdout);
pthread_mutex_unlock(&stdout_mutex);
}
/* tell client to create a new BLOB vector property */
void
IDDefBLOB (const IBLOBVectorProperty *b, const char *fmt, ...)
{
int i;
ROSC *SC;
pthread_mutex_lock(&stdout_mutex);
xmlv1();
setlocale(LC_NUMERIC,"C");
printf ("device);
printf (" name='%s'\n", b->name);
printf (" label='%s'\n", b->label);
printf (" group='%s'\n", b->group);
printf (" state='%s'\n", pstateStr(b->s));
printf (" perm='%s'\n", permStr(b->p));
printf (" timeout='%g'\n", b->timeout);
printf (" timestamp='%s'\n", timestamp());
if (fmt) {
va_list ap;
va_start (ap, fmt);
printf (" message='");
vprintf (fmt, ap);
printf ("'\n");
va_end (ap);
}
printf (">\n");
for (i = 0; i < b->nbp; i++) {
IBLOB *bp = &b->bp[i];
printf (" name);
printf (" label='%s'\n", bp->label);
printf (" />\n");
}
printf ("\n");
if (!isPropDefined(b->name))
{
/* Add this property to insure proper sanity check */
roCheck = roCheck ? (ROSC *) realloc ( roCheck, sizeof(ROSC) * (nroCheck+1))
: (ROSC *) malloc ( sizeof(ROSC));
SC = &roCheck[nroCheck++];
strcpy(SC->propName, b->name);
SC->perm = b->p;
}
setlocale(LC_NUMERIC,"");
fflush (stdout);
pthread_mutex_unlock(&stdout_mutex);
}
/* tell client to update an existing text vector property */
void
IDSetText (const ITextVectorProperty *tvp, const char *fmt, ...)
{
int i;
pthread_mutex_lock(&stdout_mutex);
xmlv1();
setlocale(LC_NUMERIC,"C");
printf ("device);
printf (" name='%s'\n", tvp->name);
printf (" state='%s'\n", pstateStr(tvp->s));
printf (" timeout='%g'\n", tvp->timeout);
printf (" timestamp='%s'\n", timestamp());
if (fmt) {
va_list ap;
va_start (ap, fmt);
printf (" message='");
vprintf (fmt, ap);
printf ("'\n");
va_end (ap);
}
printf (">\n");
for (i = 0; i < tvp->ntp; i++) {
IText *tp = &tvp->tp[i];
printf (" \n", tp->name);
printf (" %s\n", tp->text ? tp->text : "");
printf (" \n");
}
printf ("\n");
setlocale(LC_NUMERIC,"");
fflush (stdout);
pthread_mutex_unlock(&stdout_mutex);
}
/* tell client to update an existing numeric vector property */
void
IDSetNumber (const INumberVectorProperty *nvp, const char *fmt, ...)
{
int i;
pthread_mutex_lock(&stdout_mutex);
xmlv1();
setlocale(LC_NUMERIC,"C");
printf ("device);
printf (" name='%s'\n", nvp->name);
printf (" state='%s'\n", pstateStr(nvp->s));
printf (" timeout='%g'\n", nvp->timeout);
printf (" timestamp='%s'\n", timestamp());
if (fmt) {
va_list ap;
va_start (ap, fmt);
printf (" message='");
vprintf (fmt, ap);
printf ("'\n");
va_end (ap);
}
printf (">\n");
for (i = 0; i < nvp->nnp; i++) {
INumber *np = &nvp->np[i];
printf (" \n", np->name);
printf (" %.20g\n", np->value);
printf (" \n");
}
printf ("\n");
setlocale(LC_NUMERIC,"");
fflush (stdout);
pthread_mutex_unlock(&stdout_mutex);
}
/* tell client to update an existing switch vector property */
void
IDSetSwitch (const ISwitchVectorProperty *svp, const char *fmt, ...)
{
int i;
pthread_mutex_lock(&stdout_mutex);
xmlv1();
setlocale(LC_NUMERIC,"C");
printf ("device);
printf (" name='%s'\n", svp->name);
printf (" state='%s'\n", pstateStr(svp->s));
printf (" timeout='%g'\n", svp->timeout);
printf (" timestamp='%s'\n", timestamp());
if (fmt) {
va_list ap;
va_start (ap, fmt);
printf (" message='");
vprintf (fmt, ap);
printf ("'\n");
va_end (ap);
}
printf (">\n");
for (i = 0; i < svp->nsp; i++) {
ISwitch *sp = &svp->sp[i];
printf (" \n", sp->name);
printf (" %s\n", sstateStr(sp->s));
printf (" \n");
}
printf ("\n");
setlocale(LC_NUMERIC,"");
fflush (stdout);
pthread_mutex_unlock(&stdout_mutex);
}
/* tell client to update an existing lights vector property */
void
IDSetLight (const ILightVectorProperty *lvp, const char *fmt, ...)
{
int i;
pthread_mutex_lock(&stdout_mutex);
xmlv1();
printf ("device);
printf (" name='%s'\n", lvp->name);
printf (" state='%s'\n", pstateStr(lvp->s));
printf (" timestamp='%s'\n", timestamp());
if (fmt) {
va_list ap;
va_start (ap, fmt);
printf (" message='");
vprintf (fmt, ap);
printf ("'\n");
va_end (ap);
}
printf (">\n");
for (i = 0; i < lvp->nlp; i++) {
ILight *lp = &lvp->lp[i];
printf (" \n", lp->name);
printf (" %s\n", pstateStr(lp->s));
printf (" \n");
}
printf ("\n");
fflush (stdout);
pthread_mutex_unlock(&stdout_mutex);
}
/* tell client to update an existing BLOB vector property */
void
IDSetBLOB (const IBLOBVectorProperty *bvp, const char *fmt, ...)
{
int i;
pthread_mutex_lock(&stdout_mutex);
xmlv1();
setlocale(LC_NUMERIC,"C");
printf ("device);
printf (" name='%s'\n", bvp->name);
printf (" state='%s'\n", pstateStr(bvp->s));
printf (" timeout='%g'\n", bvp->timeout);
printf (" timestamp='%s'\n", timestamp());
if (fmt) {
va_list ap;
va_start (ap, fmt);
printf (" message='");
vprintf (fmt, ap);
printf ("'\n");
va_end (ap);
}
printf (">\n");
for (i = 0; i < bvp->nbp; i++) {
IBLOB *bp = &bvp->bp[i];
unsigned char *encblob;
int j, l;
printf (" name);
printf (" size='%d'\n", bp->size);
printf (" format='%s'>\n", bp->format);
encblob = malloc (4*bp->bloblen/3+4);
l = to64frombits(encblob, bp->blob, bp->bloblen);
for (j = 0; j < l; j += 72)
printf ("%.72s\n", encblob+j);
free (encblob);
printf (" \n");
}
printf ("\n");
setlocale(LC_NUMERIC,"");
fflush (stdout);
pthread_mutex_unlock(&stdout_mutex);
}
/* tell client to update min/max elements of an existing number vector property */
void IUUpdateMinMax(const INumberVectorProperty *nvp)
{
int i;
pthread_mutex_lock(&stdout_mutex);
xmlv1();
setlocale(LC_NUMERIC,"C");
printf ("device);
printf (" name='%s'\n", nvp->name);
printf (" state='%s'\n", pstateStr(nvp->s));
printf (" timeout='%g'\n", nvp->timeout);
printf (" timestamp='%s'\n", timestamp());
printf (">\n");
for (i = 0; i < nvp->nnp; i++) {
INumber *np = &nvp->np[i];
printf (" name);
printf (" min='%g'\n", np->min);
printf (" max='%g'\n", np->max);
printf (" step='%g'\n", np->step);
printf(">\n");
printf (" %g\n", np->value);
printf (" \n");
}
printf ("\n");
setlocale(LC_NUMERIC,"");
fflush (stdout);
pthread_mutex_unlock(&stdout_mutex);
}
/* Return 1 is property is already cached, 0 otherwise */
int isPropDefined(const char *property_name)
{
int i=0;
for (i=0; i < nroCheck; i++)
if (!strcmp(property_name, roCheck[i].propName))
return 1;
return 0;
}
int IUFindIndex (const char *needle, char **hay, unsigned int n)
{
int i=0;
for (i=0; i < n; i++)
if (!strcmp(hay[i], needle))
return i;
return -1;
}
libindi_1.1.0/indidriver.h 0000664 0001750 0001750 00000021134 12573036357 014513 0 ustar jasem jasem #if 0
INDI Driver Functions
Copyright (C) 2003-2015 Jasem Mutlaq
Copyright (C) 2003-2006 Elwood C. Downey
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
#endif
#ifndef INDIDRIVER_H
#define INDIDRIVER_H
#ifdef __cplusplus
extern "C" {
#endif
/* insure RO properties are never modified. RO Sanity Check */
typedef struct
{
char propName[MAXINDINAME];
IPerm perm;
} ROSC;
extern ROSC *roCheck;
extern int nroCheck; /* # of elements in roCheck */
extern int verbose; /* chatty */
extern char *me; /* a.out name */
extern LilXML *clixml; /* XML parser context */
extern int dispatch (XMLEle *root, char msg[]);
extern void clientMsgCB(int fd, void *arg);
/**
* \defgroup configFunctions Configuration Functions: Functions drivers call to save and load configuraion options.
Drivers can save properties states and values in an XML configuration file. The following functions take an optional filename
parameter which specifies the full path of the configuration file. If the filename is set to NULL, the configuration file
is locally stored in ~/.indi. By default, two configuration files may exist for each driver:
Last Saved Configuration: ~/.indi/driver_name_config.xml
libindi stores the configuration parameters enclosed in newXXX commands. Therefore, if a configuration file is loaded,
the driver property gets updated as if a client is setting these values. This is important to note since some configuration
options may only available when the device is powered up or is in a particular state.
If no filename is supplied, each function will try to create the configuration files in the following order:
INDICONFIG environment variable: The functions checks if the envrionment variable is defined, and if so, it shall
be used as the configuration filename
Generate filename: If the device_name is supplied, the function will attempt to set the configuration filename to ~/.indi/device_name_config.xml
\author Jasem Mutlaq
\note Drivers subclassing INDI::DefaultDevice do not need to call the configuration functions directly as it is handled internally by the class.
\version libindi 1.1+
*/
/*@{*/
/** \brief Open a configuration file for writing and return a configuration file FILE pointer.
\param filename full path of the configuration file. If set, the function will attempt to open it for writing.
If set to NULL, it will attempt to generate the filename as described in the Detailed Description introduction and then open it for writing.
\param dev device name. This is used if the filename parameter is NULL, and INDICONFIG environment variable is not set as described in the Detailed Description introduction.
\param errmsg In case of errors, store the error message in this buffer. The size of the buffer must be at least MAXRBUF.
\return pointer to FILE if configuration file is opened successful, otherwise NULL and errmsg is set.
*/
extern FILE * IUGetConfigFP(const char *filename, const char *dev, char errmsg[]);
/** \brief Loads and processes a configuration file.
Once a configuration file is successful loaded, the function will iterate over the enclosed newXXX commands, and dispatches
each command to the driver. Subsequently, the driver receives the updated property value in the driver's ISNewXXX functions.
The driver may call this function at any time. However, it is usually called either on driver startup or on device power up.
By default, all the properties are read from the configuration file. To load a specific property, pass the property name, otherwise
pass NULL to retrive all properties.
\param filename full path of the configuration file. If set, the function will attempt to load the file.
If set to NULL, it will attempt to generate the filename as described in the Detailed Description introduction and then load it.
\param dev device name. This is used if the filename parameter is NULL, and INDICONFIG environment variable is not set as described in the Detailed Description introduction.
\param property Property name to load configuration for. If NULL, all properties within the configuration file will be processed.
\param silent If silent is 1, it will suppress any output messages to the driver.
\param errmsg In case of errors, store the error message in this buffer. The size of the buffer must be at least MAXRBUF.
\return 0 on successful, -1 if there is an error and errmsg is set.
*/
extern int IUReadConfig(const char *filename, const char *dev, const char *property, int silent, char errmsg[]);
/** \brief Copies an existing configuration file into a default configuration file.
If no default configuration file for the supplied dev exists, it gets created and its contentes copied from an exiting source configuration file.
Usually, when the user saves the configuration file of a driver for the first time, IUSaveDefaultConfig is called to create the default
configuration file. If the default configuration file already exists, the function performs no action and returns.
\param source_config full path of the source configuration file to read. If set, the function will attempt to load the file.
If set to NULL, it will attempt to generate the filename as described in the Detailed Description introduction and then load it.
\param dest_config full path of the destination default configuration file to write. If set, the function will attempt to load the file.
If set to NULL, it will attempt to generate the filename as described in the Detailed Description introduction and then load it.
If the file already exists, the function returns. If the file doesn't exist, it gets created and its contents copied from the source_config file.
\param dev device name. This is used if either the source_config or desg_config are NULL, and INDICONFIG environment variable is not set as described in the Detailed Description introduction.
*/
extern void IUSaveDefaultConfig(const char *source_config, const char *dest_config, const char *dev);
/** \brief Add opening or closing tag to a configuration file.
A configuration file root XML element is \. This functions add \ or \ as required.
\param fp file pointer to a configuration file.
\param ctag If 0, \ is appened to the configuration file, otherwise \ is appeneded and the fp is closed.
\param dev device name. Used only for sending notification to the driver if silent is set to 1.
\param silent If silent is 1, it will suppress any output messages to the driver.
*/
extern void IUSaveConfigTag(FILE *fp, int ctag, const char *dev, int silent);
/** \brief Add a number vector property value to the configuration file
\param fp file pointer to a configuration file.
\param nvp pointer to a number vector property.
*/
extern void IUSaveConfigNumber (FILE *fp, const INumberVectorProperty *nvp);
/** \brief Add a text vector property value to the configuration file
\param fp file pointer to a configuration file.
\param tvp pointer to a text vector property.
*/
extern void IUSaveConfigText (FILE *fp, const ITextVectorProperty *tvp);
/** \brief Add a switch vector property value to the configuration file
\param fp file pointer to a configuration file.
\param svp pointer to a switch vector property.
*/
extern void IUSaveConfigSwitch (FILE *fp, const ISwitchVectorProperty *svp);
/** \brief Add a BLOB vector property value to the configuration file
\param fp file pointer to a configuration file.
\param bvp pointer to a BLOB vector property.
\note If the BLOB size is large, this function will block until the BLOB contents are written to the file.
*/
extern void IUSaveConfigBLOB (FILE *fp, const IBLOBVectorProperty *bvp);
/*@}*/
#ifdef __cplusplus
}
#endif
#endif
libindi_1.1.0/COPYING.LGPL 0000664 0001750 0001750 00000063642 12573036357 014005 0 ustar jasem jasem 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.
Copyright (C)
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.
, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!
libindi_1.1.0/Doxyfile 0000664 0001750 0001750 00000313607 12573036357 013722 0 ustar jasem jasem # Doxyfile 1.8.8
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
#
# All text after a double hash (##) is considered a comment and is placed in
# front of the TAG it is preceding.
#
# All text after a single 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.
# The default value is: UTF-8.
DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
# double-quotes, unless you are using Doxywizard) that should identify the
# project for which the documentation is generated. This name is used in the
# title of most generated pages and in a few other places.
# The default value is: My Project.
PROJECT_NAME = "Instrument Neutral Distributed Interface INDI"
# 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 = 1.0.0
# 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 =
# 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) path
# into which the generated documentation will be written. 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 = /home/jasem/Projects/doc
# 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 causes
# performance problems for the file system.
# The default value is: NO.
CREATE_SUBDIRS = NO
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
# characters to appear in the names of generated files. If set to NO, non-ASCII
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
# U+3044.
# The default value is: NO.
ALLOW_UNICODE_NAMES = 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.
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
# Ukrainian and Vietnamese.
# The default value is: English.
OUTPUT_LANGUAGE = English
# If the BRIEF_MEMBER_DESC tag is set to YES 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.
# The default value is: YES.
BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES 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.
# The default value is: YES.
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 and the.
ABBREVIATE_BRIEF =
# 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.
# The default value is: NO.
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.
# The default value is: NO.
INLINE_INHERITED_MEMB = NO
# If the FULL_PATH_NAMES tag is set to YES 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
# The default value is: YES.
FULL_PATH_NAMES = NO
# 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.
#
# Note that you can specify absolute paths here, but also relative paths, which
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
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 list of 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 is your file systems doesn't
# support long names like on DOS, Mac, or CD-ROM.
# The default value is: NO.
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-style will behave just like regular Qt-
# style comments (thus requiring an explicit @brief command for a brief
# description.)
# The default value is: NO.
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 Qt-style will behave just like regular Qt-style comments (thus
# requiring an explicit \brief command for a brief description.)
# The default value is: NO.
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 behavior. 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 behavior instead.
#
# Note that setting this tag to YES also means that rational rose comments are
# not recognized any more.
# The default value is: NO.
MULTILINE_CPP_IS_BRIEF = NO
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# documentation from any documented member that it re-implements.
# The default value is: YES.
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.
# The default value is: NO.
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.
# Minimum value: 1, maximum value: 16, default value: 4.
TAB_SIZE = 8
# This tag can be used to specify a number of aliases that act 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 =
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
# will allow you to use the command class in the itcl::class meaning.
TCL_SUBST =
# 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.
# The default value is: NO.
OPTIMIZE_OUTPUT_FOR_C = NO
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# Python sources only. Doxygen will then generate output that is more tailored
# for that language. For instance, namespaces will be presented as packages,
# qualified scopes will look different, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources. Doxygen will then generate output that is tailored for Fortran.
# The default value is: NO.
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.
# The default value is: NO.
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,
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
# Fortran. In the later case the parser tries to guess whether the code is fixed
# or free formatted code, this is the default for Fortran type files), VHDL. 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 For files without extension you can use no_extension as a placeholder.
#
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen.
EXTENSION_MAPPING =
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
# documentation. See http://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you can
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# case of backward compatibilities issues.
# The default value is: YES.
MARKDOWN_SUPPORT = YES
# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
# be prevented in individual cases by by putting a % sign in front of the word
# or globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.
AUTOLINK_SUPPORT = YES
# 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);
# versus func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
# The default value is: NO.
BUILTIN_STL_SUPPORT = NO
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
# The default value is: NO.
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# http://www.riverbankcomputing.co.uk/software/sip/intro) 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.
# The default value is: NO.
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 will make
# doxygen to 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.
# The default value is: YES.
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.
# The default value is: NO.
DISTRIBUTE_GROUP_DOC = NO
# Set the SUBGROUPING tag to YES 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.
# The default value is: YES.
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).
#
# Note that this feature does not work in combination with
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.
INLINE_GROUPED_CLASSES = NO
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
# with only public data fields or simple typedef fields will be shown inline in
# the documentation of the scope in which they are defined (i.e. file,
# namespace, or group documentation), provided this scope is documented. If set
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
# Man pages) or section (for LaTeX and RTF).
# The default value is: NO.
INLINE_SIMPLE_STRUCTS = NO
# When TYPEDEF_HIDES_STRUCT tag 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.
# The default value is: NO.
TYPEDEF_HIDES_STRUCT = NO
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
# cache is used to resolve symbols given their name and scope. Since this can be
# an expensive process and often the same symbol appears multiple times in the
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
# doxygen will become slower. If the cache is too large, memory is wasted. The
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
# symbols. At the end of a run doxygen will report the cache usage and suggest
# the optimal cache size from a speed point of view.
# Minimum value: 0, maximum value: 9, default value: 0.
LOOKUP_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 respectively EXTRACT_STATIC tags are set to YES.
# Note: This will also disable the warnings about undocumented members that are
# normally produced when WARNINGS is set to YES.
# The default value is: NO.
EXTRACT_ALL = NO
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
# be included in the documentation.
# The default value is: NO.
EXTRACT_PRIVATE = NO
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
# scope will be included in the documentation.
# The default value is: NO.
EXTRACT_PACKAGE = NO
# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
# included in the documentation.
# The default value is: NO.
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. Does not have any effect
# for Java sources.
# The default value is: YES.
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 only methods in the interface are
# included.
# The default value is: NO.
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 namespace
# are hidden.
# The default value is: NO.
EXTRACT_ANON_NSPACES = NO
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO 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.
# The default value is: NO.
HIDE_UNDOC_MEMBERS = YES
# 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 these classes will be included in the various overviews. This option has
# no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_CLASSES = YES
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
# (class|struct|union) declarations. If set to NO these declarations will be
# included in the documentation.
# The default value is: NO.
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 these
# blocks will be appended to the function's detailed documentation block.
# The default value is: NO.
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 then the documentation
# will be excluded. Set it to YES to include the internal documentation.
# The default value is: NO.
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.
# The default value is: system dependent.
CASE_SENSE_NAMES = YES
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
# their full class and namespace scopes in the documentation. If set to YES the
# scope will be hidden.
# The default value is: NO.
HIDE_SCOPE_NAMES = NO
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
# the files that are included by a file in the documentation of that file.
# The default value is: YES.
SHOW_INCLUDE_FILES = YES
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
# grouped member an include statement to the documentation, telling the reader
# which file to include in order to use the member.
# The default value is: NO.
SHOW_GROUPED_MEMB_INC = NO
# 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.
# The default value is: NO.
FORCE_LOCAL_INCLUDES = NO
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
# documentation for inline members.
# The default value is: YES.
INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES 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.
# The default value is: YES.
SORT_MEMBER_DOCS = YES
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member
# name. If set to NO the members will appear in declaration order. Note that
# this will also influence the order of the classes in the class list.
# The default value is: NO.
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 constructors will appear in the
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
# member documentation.
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
# detailed member documentation.
# The default value is: 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 group names will
# appear in their defined order.
# The default value is: NO.
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 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.
# The default value is: NO.
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.
# The default value is: NO.
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.
# The default value is: YES.
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.
# The default value is: YES.
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.
# The default value is: YES.
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.
# The default value is: YES.
GENERATE_DEPRECATEDLIST= YES
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
# sections, marked by \if ... \endif and \cond
# ... \endcond blocks.
ENABLED_SECTIONS =
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
# initial value of a variable or macro / define can have 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 value of individual variables and macros / defines can be
# controlled using \showinitializer or \hideinitializer command in the
# documentation regardless of this setting.
# Minimum value: 0, maximum value: 10000, default value: 30.
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.
# The default value is: YES.
SHOW_USED_FILES = YES
# 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 value 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 value 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. For an example see the documentation.
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. To 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.
#
# Note that if you run doxygen from a directory containing a file called
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
LAYOUT_FILE =
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
# extension is automatically appended if omitted. This requires the bibtex tool
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
# For LaTeX the style of the bibliography can be controlled using
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
# search path. See also \cite for info how to create references.
CITE_BIB_FILES =
#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
# The QUIET tag can be used to turn on/off the messages that are generated to
# standard output by doxygen. If QUIET is set to YES this implies that the
# messages are off.
# The default value is: NO.
QUIET = NO
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
# this implies that the warnings are on.
#
# Tip: Turn warnings on while writing the documentation.
# The default value is: YES.
WARNINGS = YES
# If the WARN_IF_UNDOCUMENTED tag 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.
# The default value is: YES.
WARN_IF_UNDOCUMENTED = YES
# If the WARN_IF_DOC_ERROR tag 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.
# The default value is: YES.
WARN_IF_DOC_ERROR = YES
# This 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 doxygen will only warn about wrong or incomplete parameter
# documentation, but not about the absence of documentation.
# The default value is: NO.
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)
# The default value is: $file:$line: $text.
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 standard
# error (stderr).
WARN_LOGFILE =
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
# The INPUT tag is 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.
# Note: If this tag is empty the current directory is searched.
INPUT = /home/jasem/Projects/indi/trunk/libindi
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
# possible encodings.
# The default value is: UTF-8.
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 patterns (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++, *.java, *.ii,
# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
# *.qsf, *.as and *.js.
FILE_PATTERNS = *.c \
*.cc \
*.cxx \
*.cpp \
*.c++ \
*.java \
*.ii \
*.ixx \
*.ipp \
*.i++ \
*.inl \
*.h \
*.hh \
*.hxx \
*.hpp \
*.h++ \
*.idl \
*.odl \
*.cs \
*.php \
*.php3 \
*.inc \
*.C \
*.H \
*.tlh \
*.diff \
*.patch \
*.moc \
*.xpm \
*.dox \
*.md
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.
RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should be
# 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.
#
# Note that relative paths are relative to the directory from which doxygen is
# run.
EXCLUDE = /home/jasem/Projects/indi/trunk/libindi/drivers \
/home/jasem/Projects/indi/trunk/libindi/tools \
/home/jasem/Projects/indi/trunk/libindi/libs/base64.c \
/home/jasem/Projects/indi/trunk/libindi/libs/fq.c \
/home/jasem/Projects/indi/trunk/libindi/indidrivermain.c \
/home/jasem/Projects/indi/trunk/libindi/indiserver.c
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
# from the input.
# The default value is: NO.
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 =
# 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
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */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 = /home/jasem/Projects/indi/trunk/libindi/examples
# 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.
# The default value is: NO.
EXAMPLE_RECURSIVE = YES
# The IMAGE_PATH tag can be used to specify one or more files or directories
# that contain images that are to be included in the documentation (see the
# \image command).
IMAGE_PATH = libs/indibase/alignment
# 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:
#
#
#
# where is the value of the INPUT_FILTER tag, and 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.
#
# Note that the filter must not add or remove lines; it is applied before the
# code is scanned, but not when the output code is generated. If lines are added
# or removed, the anchors will not be placed correctly.
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 information on how
# filters are used. If the FILTER_PATTERNS tag is empty or if none 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 also be used to filter the input files that are used for
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
# The default value is: NO.
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 tag requires that the tag FILTER_SOURCE_FILES is set to YES.
FILTER_SOURCE_PATTERNS =
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
# is part of the input, its contents will be placed on the main page
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
USE_MDFILE_AS_MAINPAGE =
#---------------------------------------------------------------------------
# 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 that
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.
SOURCE_BROWSER = YES
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
# classes and enums directly into the documentation.
# The default value is: NO.
INLINE_SOURCES = NO
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
# special comment blocks from generated source code fragments. Normal C, C++ and
# Fortran comments will always remain visible.
# The default value is: YES.
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.
# The default value is: NO.
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.
# The default value is: NO.
REFERENCES_RELATION = NO
# If the REFERENCES_LINK_SOURCE tag is set to YES 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.
# The default value is: YES.
REFERENCES_LINK_SOURCE = YES
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
# source code will show a tooltip with additional information such as prototype,
# brief description and links to the definition and documentation. Since this
# will make the HTML file larger and loading of large files a bit slower, you
# can opt to disable this feature.
# The default value is: YES.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
SOURCE_TOOLTIPS = 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.
#
# To use it do the following:
# - Install the latest version of global
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
# - Make sure the INPUT points to the root of the source tree
# - Run doxygen as normal
#
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
# tools must be available from the command line (i.e. in the search path).
#
# The result: instead of the source browser generated by doxygen, the links to
# source code will now point to the output of htags.
# The default value is: NO.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
USE_HTAGS = NO
# If the VERBATIM_HEADERS tag is set the YES 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.
# See also: Section \class.
# The default value is: YES.
VERBATIM_HEADERS = NO
# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the
# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
# cost of reduced performance. This can be particularly helpful with template
# rich C++ code for which doxygen's built-in parser lacks the necessary type
# information.
# Note: The availability of this option depends on whether or not doxygen was
# compiled with the --with-libclang option.
# The default value is: NO.
CLANG_ASSISTED_PARSING = NO
# If clang assisted parsing is enabled you can provide the compiler with command
# line options that you would normally use when invoking the compiler. Note that
# the include paths will already be set by doxygen for the files and directories
# specified with INPUT and INCLUDE_PATH.
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
CLANG_OPTIONS =
#---------------------------------------------------------------------------
# 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.
# The default value is: YES.
ALPHABETICAL_INDEX = YES
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
# which the alphabetical index list will be split.
# Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
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 a prefix (or a list of prefixes) that should be ignored
# while generating the index headers.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
# The default value is: YES.
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.
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = doc
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
# The default value is: .html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FILE_EXTENSION = .html
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
# each generated HTML page. If the tag is left blank doxygen will generate a
# standard header.
#
# To get valid HTML the header file that includes any scripts and style sheets
# that doxygen needs, which is dependent on the configuration options used (e.g.
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
# default header using
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
# YourConfigFile
# and then modify the file new_header.html. See also section "Doxygen usage"
# for information on how to generate the default header that doxygen normally
# uses.
# Note: The header is subject to change so you typically have to regenerate the
# default header when upgrading to a newer version of doxygen. For a description
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER =
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
# footer. See HTML_HEADER for more information on how to generate a default
# footer and what special commands can be used inside the footer. See also
# section "Doxygen usage" for information on how to generate the default footer
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
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 left blank doxygen will generate a default style sheet.
# See also section "Doxygen usage" for information on how to generate the style
# sheet that doxygen normally uses.
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET =
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
# created by doxygen. Using this option one can overrule certain style aspects.
# This is preferred over using HTML_STYLESHEET since it does not replace the
# standard style sheet and is therefor more robust against future updates.
# Doxygen will copy the style sheet files to the output directory.
# Note: The order of the extra stylesheet files is of importance (e.g. the last
# stylesheet in the list overrules the setting of the previous ones in the
# list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_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.
# This tag requires that the tag GENERATE_HTML is set to YES.
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.
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
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.
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
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.
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
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.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_TIMESTAMP = 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.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_SECTIONS = NO
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand
# and collapse entries dynamically later on. Doxygen will expand the tree to
# such a level that at most the specified number of entries are visible (unless
# a fully collapsed tree already exceeds this amount). So setting the number of
# entries 1 will produce a full collapsed tree by default. 0 is a special value
# representing an infinite number of entries and will result in a full expanded
# tree by default.
# Minimum value: 0, maximum value: 9999, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_INDEX_NUM_ENTRIES = 100
# 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 (see: http://developer.apple.com/tools/xcode/), 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.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_DOCSET = NO
# This tag determines the name of the docset 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.
# The default value is: Doxygen generated docs.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_FEEDNAME = "Doxygen generated docs"
# 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.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_BUNDLE_ID = org.doxygen.Project
# The DOCSET_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.
# The default value is: org.doxygen.Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
# The default value is: Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_NAME = Publisher
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
# Windows.
#
# The HTML Help Workshop contains a compiler that can convert all HTML output
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
# files are now used as the Windows 98 help format, and will replace the old
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
# HTML files also contain an index, a table of contents, and you can search for
# words in the documentation. The HTML workshop also contains a viewer for
# compressed HTML files.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_HTMLHELP = NO
# 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.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_FILE =
# 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.
# The file has to be specified with full path.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
HHC_LOCATION =
# 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).
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
GENERATE_CHI = NO
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
# and project file content.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_INDEX_ENCODING =
# 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. Furthermore it
# enables the Previous and Next buttons.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
# the table of contents of the HTML help documentation and to the tree view.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
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.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
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.
# This tag requires that the tag GENERATE_QHP is set to YES.
QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
# Project output. For more information please see Qt Help Project / Namespace
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_QHP is set to YES.
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 Qt Help Project / Virtual
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
# folders).
# The default value is: doc.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_VIRTUAL_FOLDER = doc
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
# filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's filter section matches. Qt Help Project / Filter Attributes (see:
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_SECT_FILTER_ATTRS =
# 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.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHG_LOCATION =
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
# generated, together with the HTML files, they 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.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
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. Each documentation set should have its own identifier.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
ECLIPSE_DOC_ID = org.doxygen.Project
# If you want full control over the layout of the generated HTML pages it might
# be necessary to disable the index and replace it with your own. The
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
# of each HTML page. A value of NO enables the index and the value YES disables
# it. Since the tabs in the index contain the same information as the navigation
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
DISABLE_INDEX = NO
# 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. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
# further fine-tune the look of the index. As an example, the default style
# sheet generated by doxygen has an example that shows how to put an image at
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
# the same information as the tab index, you could consider setting
# DISABLE_INDEX to YES when enabling this option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_TREEVIEW = NO
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 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.
# Minimum value: 0, maximum value: 20, default value: 4.
# This tag requires that the tag GENERATE_HTML is set to YES.
ENUM_VALUES_PER_LINE = 4
# 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.
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.
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.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
EXT_LINKS_IN_WINDOW = NO
# Use this tag to change the font size of LaTeX formulas included as images in
# the HTML documentation. 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.
# Minimum value: 8, maximum value: 50, default value: 10.
# This tag requires that the tag GENERATE_HTML is set to YES.
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 directory before the changes have effect.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
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 may also need to install MathJax separately and configure the path
# to it using the MATHJAX_RELPATH option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
USE_MATHJAX = NO
# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. See the MathJax site (see:
# http://docs.mathjax.org/en/latest/output.html) for more details.
# Possible values are: HTML-CSS (which is slower, but has the best
# compatibility), NativeMML (i.e. MathML) and SVG.
# The default value is: HTML-CSS.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_FORMAT = HTML-CSS
# 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
# Content Delivery Network so you can quickly see the result without installing
# MathJax. However, it is strongly recommended to install a local copy of
# MathJax from http://www.mathjax.org before deployment.
# The default value is: http://cdn.mathjax.org/mathjax/latest.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
# extension names that should be enabled during MathJax rendering. For example
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_EXTENSIONS =
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
# of code that will be used on startup of the MathJax code. See the MathJax site
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
# example see the documentation.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_CODEFILE =
# 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. It is possible to
# search using the keyboard; to jump to the search box use + S
# (what the is depends on the OS and browser, but it is typically
# , /