Credit Andrew - improve in-tree documentation
[goodguy/cinelerra.git] / cinelerra / filexml.h
1
2 /*
3  * CINELERRA
4  * Copyright (C) 2008 Adam Williams <broadcast at earthling dot net>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  */
21
22 #ifndef FILEXML_H
23 #define FILEXML_H
24
25 #include <stdio.h>
26 #include <stdint.h>
27 #include <limits.h>
28
29 #include "arraylist.h"
30 #include "mutex.h"
31 #include "keyframe.inc"
32 #include "filexml.inc"
33 #include "sizes.h"
34
35 #define MAX_TITLE 256
36
37 class XMLBuffer
38 {
39         long bsz, isz;
40         unsigned char *inp, *outp, *bfr, *lmt;
41         int destroy;
42         Mutex *share_lock;
43
44         int demand(long len);
45         friend class KeyFrame;
46         friend class FileXML;
47 public:
48         XMLBuffer(long buf_size=0x1000, long max_size=LONG_MAX, int del=1);
49         XMLBuffer(long buf_size, char *buf, int del=0); // writing
50         XMLBuffer(const char *buf, long buf_size, int del=0); // reading
51         ~XMLBuffer();
52
53         long otell() { return inp - bfr; }
54         long itell() { return outp - bfr; }
55         void oseek(long pos) { inp = bfr + pos; }
56         void iseek(long pos) { outp = bfr + pos; }
57         unsigned char *pos(long ofs=0) { return bfr+ofs; }
58         char *cstr() { if( demand(otell()+1) ) *inp = 0; return (char*)bfr; }
59         int read(char *bp, int n);
60         int write(const char *bp, int n);
61         void copy_from(XMLBuffer *xbfr);
62
63         int cur()  { return outp>=inp ? -1 : *outp; }
64         int next() { return outp>=inp ? -1 : *outp++; }
65         int next(int ch) { return !demand(otell()+1) ? -1 : *inp++ = ch; }
66
67         static char *decode_data(char *bp, const char *sp, int n=-1);
68         static char *encode_data(char *bp, const char *sp, int n=-1);
69         static char *copy_data(char *bp, const char *sp, int n=-1);
70         static long encoded_length(const char *sp, int n=-1);
71         static long copy_length(const char *sp, int n=-1);
72 };
73
74 class XMLTag
75 {
76         XMLBuffer *buffer;
77         class Property {
78         public:
79                 const char *prop;
80                 const char *value;
81
82                 Property(const char *pp, const char *vp);
83                 ~Property();
84         };
85         bool ws(char ch) { return ch==' ' || ch=='\n'; }
86
87 public:
88         XMLTag();
89         ~XMLTag();
90
91         int reset_tag();
92
93         int title_is(const char *title);
94         char *get_title();
95         int get_title(char *value);
96         int test_property(char *property, char *value);
97         const char *get_property_text(int number);
98         int get_property_int(int number);
99         float get_property_float(int number);
100         const char *get_property(const char *property);
101         const char* get_property(const char *property, char *value);
102         int32_t get_property(const char *property, int32_t default_);
103         int64_t get_property(const char *property, int64_t default_);
104         float get_property(const char *property, float default_);
105         double get_property(const char *property, double default_);
106
107         int set_title(const char *text);
108         int set_property(const char *text, const char *value);
109         int set_property(const char *text, int32_t value);
110         int set_property(const char *text, int64_t value);
111         int set_property(const char *text, float value);
112         int set_property(const char *text, double value);
113
114         int write_tag(FileXML *xml);
115         int read_tag(FileXML *xml);
116
117         char title[MAX_TITLE];
118         ArrayList<Property*> properties;
119         char *string;
120         long used, avail;
121 };
122
123
124 class FileXML
125 {
126 public:
127         FileXML(int coded=1);
128         ~FileXML();
129
130         int terminate_string();
131         int append_newline();
132         int append_tag();
133         int append_text(const char *text);
134         int append_text(const char *text, long len);
135         int append_data(const char *text);
136         int append_data(const char *text, long len);
137
138         char *read_text();
139         int read_data_until(const char *tag_end, XMLBuffer *xbfr, int skip=0);
140         int read_text_until(const char *tag_end, XMLBuffer *xbfr, int skip=0);
141         int read_tag();
142         int skip_tag();
143         int write_to_file(const char *filename);
144         int write_to_file(FILE *file, const char *filename="");
145         int read_from_file(const char *filename, int ignore_error = 0);
146         int read_from_string(char *string);
147         char *(*decode)(char *bp, const char *sp, int n);
148         char *(*encode)(char *bp, const char *sp, int n);
149         long (*coded_length)(const char *sp, int n);
150
151         void set_coding(int coding);
152         int get_coding();
153         int set_shared_input(XMLBuffer *xbfr);
154         int set_shared_output(XMLBuffer *xbfr);
155
156         int rewind();
157         char *get_data();
158         char *string();
159         long length();
160
161         XMLBuffer *buffer;
162         int coded, shared;
163
164         XMLTag tag;
165         long output_length;
166         char *output;
167         char left_delimiter, right_delimiter;
168         char filename[MAX_TITLE];
169         static const char *xml_header;
170         static const int xml_header_size;
171 };
172
173 #endif