b803f81707fdc1011588c4011893651258ab2a68
[smdp.git] / include / markdown.h
1 #if !defined( MARKDOWN_H )
2 #define MARKDOWN_H
3
4 /*
5  * An implementation of markdown objects.
6  * Copyright (C) 2014 Michael Goehler
7  *
8  * This file is part of mdp.
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program. If not, see <http://www.gnu.org/licenses/>.
22  *
23  *
24  * enum: line_bitmask which enumerates markdown formating bits
25  *
26  * struct: deck_t the root object representing a deck of slides
27  * struct: slide_t a linked list element of type slide contained in a deck
28  * struct: line_t a linked list element of type line contained in a slide
29  *
30  * function: new_deck to initialize a new deck
31  * function: new_slide to initialize a new linked list of type slide
32  * function: next_slide to extend a linked list of type slide by one element
33  * function: new_line to initialize a new linked list of type line
34  * function: next_line to extend a linked list of type line by one element
35  *
36  */
37
38 #include "cstring.h"
39 #include "bitops.h"
40
41 enum line_bitmask {
42     IS_H1,
43     IS_H1_ATX,
44     IS_H2,
45     IS_H2_ATX,
46     IS_QUOTE,
47     IS_CODE,
48     IS_HR,
49     IS_UNORDERED_LIST_1,
50     IS_UNORDERED_LIST_2,
51     IS_UNORDERED_LIST_3,
52     IS_UNORDERED_LIST_EXT,
53     IS_CENTER,
54     IS_EMPTY
55 };
56
57 typedef struct _line_t {
58     cstring_t *text;
59     struct _line_t *prev;
60     struct _line_t *next;
61     int bits;
62     int length;
63     int offset;
64 } line_t;
65
66 typedef struct _slide_t {
67     line_t *line;
68     struct _slide_t *prev;
69     struct _slide_t *next;
70     int lines;
71 } slide_t;
72
73 typedef struct _deck_t {
74     line_t *header;
75     slide_t *slide;
76     int slides;
77     int headers;
78 } deck_t;
79
80 line_t *new_line();
81 line_t *next_line(line_t *prev);
82 slide_t *new_slide();
83 slide_t *next_slide(slide_t *prev);
84 deck_t *new_deck();
85 void free_deck(deck_t *);
86
87 #endif // !defined( MARKDOWN_H )