2 * Copyright (c) 2016, Olivier MATZ <zer0@droids-corp.org>
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the University of California, Berkeley nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #ifndef ECOLI_TK_BYPASS_
29 #define ECOLI_TK_BYPASS_
33 /// XXX rename in loop ?
34 // XXX + provide the helper to free ?
36 /* a tk that just behaves like its child
37 * useful to create cyclic graphs of tokens:
38 * creating a loop (with clones) result in something that is not
39 * freeable, due to reference counters
40 * bypass node can solve the issue: before freeing the graph,
41 * the loop can be cut, falling back to a valid tree that can
48 * seq_add(seq, clone(seq))
49 * FAIL, cannot be freed
52 * bypass = bypass(clone(seq))
55 * seq_add(seq, bypass)
58 * seq2 = bypass_del(bypass) // breaks the loop (seq2 == seq)
64 struct ec_tk *ec_tk_bypass(const char *id, struct ec_tk *child);
66 struct ec_tk *ec_tk_bypass_empty(const char *id);
68 /* child is consumed */
69 /* all token given in the list will be freed when freeing this one */
70 int ec_tk_bypass_set(struct ec_tk *tk, struct ec_tk *child);
72 struct ec_tk *ec_tk_bypass_pop(struct ec_tk *gen_tk);