File: fors_paf.h

package info (click to toggle)
cpl-plugin-vimos 2.9.15%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 18,560 kB
  • ctags: 6,341
  • sloc: ansic: 148,777; sh: 11,457; cpp: 724; makefile: 606; python: 287; perl: 10
file content (166 lines) | stat: -rw-r--r-- 4,861 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/* $Id: fors_paf.h,v 1.1 2010-06-16 11:07:49 cizzo Exp $
 *
 * This file is part of the FORS Library
 * Copyright (C) 2000-2006 European Southern Observatory
 *
 * 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 St, Fifth Floor, Boston, MA  02110-1301 USA
 */

/*
 * $Author: cizzo $
 * $Date: 2010-06-16 11:07:49 $
 * $Revision: 1.1 $
 * $Name: not supported by cvs2svn $
 */
 
#ifndef FORS_PAF_H
#define FORS_PAF_H

#include <sys/types.h>

#include <cpl.h>


CPL_BEGIN_DECLS

/*
 * Maximum length of a parameter file record, i.e. maximum number of
 * characters per line of a parameter file on disk. This does not include
 * a trailing 0.
 */

#define PAF_RECORD_MAX  (256)


/*
 * PAF value types
 */

enum _FORS_PAF_TYPE_ {
    PAF_TYPE_NONE,
    PAF_TYPE_BOOL,
    PAF_TYPE_INT,
    PAF_TYPE_DOUBLE,
    PAF_TYPE_STRING
};

typedef enum _FORS_PAF_TYPE_ ForsPAFType;

/*
 * PAF object
 */

typedef struct _FORS_PAF_ ForsPAF;

/*
 * Create, copy and destroy operations
 */

ForsPAF *newForsPAF(const char *, const char *, const char *,
                          const char *);
void deleteForsPAF(ForsPAF *);

/*
 * Nonmodifying operations
 */

int forsPAFIsEmpty(const ForsPAF *);
size_t forsPAFGetSize(const ForsPAF *);
int forsPAFContains(const ForsPAF *, const char *);
size_t forsPAFCount(const ForsPAF *, const char *);

/*
 * Header operations
 */

ForsPAFType forsPAFType(const ForsPAF *, const char *);

const char *forsPAFGetName(const ForsPAF *);
const char *forsPAFGetTag(const ForsPAF *);
const char *forsPAFGetId(const ForsPAF *);
const char *forsPAFGetDescription(const ForsPAF *);

int forsPAFSetName(ForsPAF *, const char *);
int forsPAFSetTag(ForsPAF *, const char *);
int forsPAFSetId(ForsPAF *, const char *);
int forsPAFSetDescription(ForsPAF *, const char *);

int forsPAFSetHeader(ForsPAF *, const char *, const char *, const char *,
                    const char *);

/*
 * Element access
 */

int forsPAFGetValueBool(const ForsPAF *, const char *);
int forsPAFGetValueInt(const ForsPAF *, const char *);
double forsPAFGetValueDouble(const ForsPAF *, const char *);
const char *forsPAFGetValueString(const ForsPAF *, const char *);
const char *forsPAFGetComment(const ForsPAF *, const char *);

int forsPAFSetValueBool(ForsPAF *, const char *, int);
int forsPAFSetValueInt(ForsPAF *, const char *, int);
int forsPAFSetValueDouble(ForsPAF *, const char *, double);
int forsPAFSetValueString(ForsPAF *, const char *, const char *);
int forsPAFSetComment(ForsPAF *, const char *, const char *);

/*
 * Inserting and removing elements
 */

int forsPAFInsertBool(ForsPAF *, const char *, const char *, int, const char *);
int forsPAFInsertInt(ForsPAF *, const char *, const char *, int, const char *);
int forsPAFInsertDouble(ForsPAF *, const char *, const char *, double,
                       const char *);
int forsPAFInsertString(ForsPAF *, const char *, const char *, const char *,
                       const char *);

int forsPAFInsertAfterBool(ForsPAF *, const char *, const char *, int,
                          const char *);
int forsPAFInsertAfterInt(ForsPAF *, const char *, const char *, int,
                         const char *);
int forsPAFInsertAfterDouble(ForsPAF *, const char *, const char *, double,
                            const char *);
int forsPAFInsertAfterString(ForsPAF *, const char *, const char *,
                            const char *, const char *);

int forsPAFPrependBool(ForsPAF *, const char *, int, const char *);
int forsPAFPrependInt(ForsPAF *, const char *, int, const char *);
int forsPAFPrependDouble(ForsPAF *, const char *, double, const char *);
int forsPAFPrependString(ForsPAF *, const char *, const char *, const char *);

int forsPAFAppendBool(ForsPAF *, const char *, int, const char *);
int forsPAFAppendInt(ForsPAF *, const char *, int, const char *);
int forsPAFAppendDouble(ForsPAF *, const char *, double, const char *);
int forsPAFAppendString(ForsPAF *, const char *, const char *, const char *);

void forsPAFErase(ForsPAF *, const char *);
void forsPAFClear(ForsPAF *);

/*
 * Read and write operations
 */

int forsPAFWrite(ForsPAF *);

/*
 * Miscellaneous utilities
 */

int forsPAFIsValidName(const char *);

CPL_END_DECLS

#endif /* FORS_PAF_H */