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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
/*
* Gregorio is a program that translates gabc files to GregorioTeX
* This header defines the Gregorio data structures and functions.
*
* Copyright (C) 2016-2018 The Gregorio Project (see CONTRIBUTORS.md)
*
* This file is part of Gregorio.
*
* Gregorio 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 3 of the License, or
* (at your option) any later version.
*
* Gregorio 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 Gregorio. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file
* The file starts by the definition of all the structures used in
* gregorio. As it is certainly the most important file for
* understanding, read it carefully.
*/
#ifndef STRUCT_ITER_H
#define STRUCT_ITER_H
#include "struct.h"
/* This enum defines bitfields selecting the node types that should be passed
* to end_item in gregorio_from_note_to_note */
typedef enum {
GRESTRUCT_NONE = 0,
GRESTRUCT_NOTE = 1 << 0,
GRESTRUCT_GLYPH = 1 << 1,
GRESTRUCT_ELEMENT = 1 << 2,
GRESTRUCT_SYLLABLE = 1 << 3
} gregorio_note_iter_item_type;
typedef struct {
gregorio_syllable *syllable;
gregorio_element *element;
gregorio_glyph *glyph;
gregorio_note *note;
} gregorio_note_iter_position;
static __inline void gregorio_from_note_to_note(
const gregorio_note_iter_position *const start,
const gregorio_note_iter_position *const end, bool include_end,
void (*const visit)(const gregorio_note_iter_position *, void *),
void (*const end_item)(const gregorio_note_iter_position *,
gregorio_note_iter_item_type, void *),
const gregorio_note_iter_item_type desired_iter_items, void *data)
{
/* Note: include_end is effectively ignored if end is NULL */
gregorio_note_iter_position p = *start;
while (p.syllable) {
if (!p.element) {
p.element = p.syllable->elements[0];
}
while (p.element) {
if (p.element->type == GRE_ELEMENT) {
if (!p.glyph) {
p.glyph = p.element->u.first_glyph;
}
while (p.glyph) {
if (p.glyph->type == GRE_GLYPH) {
if (!p.note) {
p.note = p.glyph->u.notes.first_note;
}
while (p.note) {
bool at_end = (end && p.note == end->note);
if (p.note->type == GRE_NOTE
&& (!at_end || include_end)) {
visit(&p, data);
}
if (at_end) {
if (end_item) {
/* in 4.2.0, this code is never hit, as
* end_item will only be supplied from
* gregorio_for_each_note, which supplies
* NULL for end */
/* LCOV_EXCL_START */
/* to enable the real code, delete this
* assertion: */
gregorio_fail(gregorio_from_note_to_note,
"unused code path");
if (desired_iter_items & GRESTRUCT_NOTE) {
end_item(&p, GRESTRUCT_NOTE, data);
}
if (desired_iter_items & GRESTRUCT_GLYPH) {
end_item(&p, GRESTRUCT_GLYPH, data);
}
if (desired_iter_items
& GRESTRUCT_ELEMENT) {
end_item(&p, GRESTRUCT_ELEMENT, data);
}
if (desired_iter_items
& GRESTRUCT_SYLLABLE) {
end_item(&p, GRESTRUCT_SYLLABLE, data);
}
}
/* LCOV_EXCL_END */
return;
}
if (end_item
&& (desired_iter_items & GRESTRUCT_NOTE)) {
/* in 4.2.0, this code is never hit, as the only
* usage that gets through to here does not
* include GRESTRUCT_NOTE in desired_iter_items */
/* LCOV_EXCL_START */
/* to enable the real code, delete this
* assertion: */
gregorio_fail(gregorio_from_note_to_note,
"unused code path");
end_item(&p, GRESTRUCT_NOTE, data);
}
/* LCOV_EXCL_STOP */
p.note = p.note->next;
} /* note */
}
if (end_item && (desired_iter_items & GRESTRUCT_GLYPH)) {
/* in 4.2.0, this code is never hit, as the only usage
* that gets through to here does not include
* GRESTRUCT_GLYPH in desired_iter_items */
/* LCOV_EXCL_START */
/* to enable the real code, delete this assertion: */
gregorio_fail(gregorio_from_note_to_note,
"unused code path");
end_item(&p, GRESTRUCT_GLYPH, data);
}
/* LCOV_EXCL_STOP */
p.glyph = p.glyph->next;
} /* glyph */
}
if (end_item && (desired_iter_items & GRESTRUCT_ELEMENT)) {
end_item(&p, GRESTRUCT_ELEMENT, data);
}
p.element = p.element->next;
} /* element */
if (end_item && (desired_iter_items & GRESTRUCT_SYLLABLE)) {
/* in 4.2.0, this code is never hit, as the only usage that gets
* through to here does not include GRESTRUCT_SYLLABLE in
* desired_iter_items */
/* LCOV_EXCL_START */
/* to enable the real code, delete this assertion: */
gregorio_fail(gregorio_from_note_to_note, "unused code path");
end_item(&p, GRESTRUCT_SYLLABLE, data);
}
/* LCOV_EXCL_STOP */
p.syllable = p.syllable->next_syllable;
} /* syllable */
}
static __inline void gregorio_for_each_note(const gregorio_score *score,
void (*const visit)(const gregorio_note_iter_position *, void *),
void (*const end_item)(const gregorio_note_iter_position *,
gregorio_note_iter_item_type, void *),
const gregorio_note_iter_item_type desired_iter_items, void *data)
{
gregorio_note_iter_position p = {
/* .syllable = */ NULL,
/* .element = */ NULL,
/* .glyph = */ NULL,
/* .note = */ NULL
};
p.syllable = score->first_syllable;
gregorio_from_note_to_note(&p, NULL, true, visit, end_item,
desired_iter_items, data);
}
#endif
|
