]> git.donarmstrong.com Git - lilypond.git/blob - lily/undead.cc
Doc-es: update Learning/Fundamental.
[lilypond.git] / lily / undead.cc
1 /*
2   This file is part of LilyPond, the GNU music typesetter.
3
4   Copyright (C) 2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
5
6   LilyPond 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 3 of the License, or
9   (at your option) any later version.
10
11   LilyPond 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 LilyPond.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #include "smobs.hh"
21
22 class Undead : public Simple_smob<Undead>
23 {
24 public:
25   int print_smob (SCM, scm_print_state *) const;
26   SCM mark_smob () const;
27   static const char * const type_p_name_;
28 private:
29   SCM object_;
30 public:
31   SCM object () const { return object_; }
32   Undead (SCM object = SCM_UNDEFINED) : object_ (object) { };
33 };
34
35 SCM
36 Undead::mark_smob () const
37 {
38   bool saved = parsed_objects_should_be_dead;
39   parsed_objects_should_be_dead = false;
40   scm_gc_mark (object ());
41   parsed_objects_should_be_dead = saved;
42   return SCM_UNDEFINED;
43 }
44
45 int
46 Undead::print_smob (SCM port, scm_print_state *) const
47 {
48   scm_puts ("#<Undead ", port);
49   scm_display (object (), port);
50   scm_puts (" >", port);
51   return 1;
52 }
53
54 const char * const Undead::type_p_name_ = "ly:undead?";
55
56 LY_DEFINE (ly_make_undead, "ly:make-undead",
57            1, 0, 0, (SCM object),
58            "This packages @var{object} in a manner that keeps it from"
59            " triggering \"Parsed object should be dead\" messages.")
60 {
61   Undead undead (object);
62   return undead.smobbed_copy ();
63 }
64
65 LY_DEFINE (ly_get_undead, "ly:get-undead",
66            1, 0, 0, (SCM undead),
67            "Get back object from @var{undead}.")
68 {
69   LY_ASSERT_SMOB (Undead, undead, 1);
70   return unsmob<Undead> (undead)->object ();
71 }
72
73 // '
74 // These are not protected since the means of protecting them would be
75 // problematic to trigger during the mark pass where the array element
76 // references get set.  However, they get set only when in the mark
77 // pass when checking for parsed elements that should be dead, and we
78 // query and clear them immediately afterwards.  So there should be no
79 // way in which the references would have become unprotected in the
80 // mean time.
81
82 vector<parsed_dead *> parsed_dead::elements;
83
84 SCM
85 parsed_dead::readout ()
86 {
87   SCM result = SCM_EOL;
88   for (vsize i = 0; i < elements.size (); i++)
89     {
90       SCM elt = elements[i]->readout_one ();
91       if (!SCM_UNBNDP (elt))
92         result = scm_cons (elt, result);
93     }
94   return result;
95 }
96
97 LY_DEFINE (ly_parsed_undead_list_x, "ly:parsed-undead-list!",
98            0, 0, 0, (),
99            "Return the list of objects that have been found live"
100            " that should have been dead, and clear that list.")
101 {
102   return parsed_dead::readout ();
103 }