2 register.hh -- part of LilyPond
4 (c) 1996,1997 Han-Wen Nienhuys <hanwen@stack.nl>
13 #include "staff-elem-info.hh"
14 #include "staff-info.hh"
17 a struct which processes requests, and creates the #Staff_elem#s.
18 It may use derived classes. Hungarian postfix: register
20 class Request_register {
21 friend class Register_group_register;
23 You cannot copy a Request_register
25 Request_register(const Request_register&){}
29 virtual Paper_def * paper() const;
32 try to fit the request in this register
35 false: not noted, not taken.
37 true: request swallowed. Don't try to put the request elsewhere.
40 Default: always return false
42 virtual bool try_request(Request *req_l);
44 /// make items/spanners with the requests you got
45 virtual void process_requests(){}
47 /** typeset any items/spanners. Default: do nothing
49 virtual void pre_move_processing(){}
50 /** reset any appropriate data. Default: do nothing
52 virtual void post_move_processing(){}
55 Is this request eligible to be processed? Default: return false.
57 virtual bool acceptable_request_b(Request*) const;
60 typeset a "command" item. Default: pass on to daddy.
61 If the column is not breakable, #pre_p# and #post_p# are junked
63 virtual void typeset_breakable_item(Item * pre_p ,
64 Item * nobreak_p, Item * post_p);
66 Invoke walker method to typeset element. Default: pass on to daddy.
68 virtual void typeset_element(Staff_elem*elem_p);
71 take note of item/spanner
72 put item in spanner. Adjust local key; etc.
74 Default: ignore the info
76 virtual void acknowledge_element(Staff_elem_info) {}
78 Announce element. Default: pass on to daddy. Utility
80 virtual void announce_element(Staff_elem_info);
82 Set features of the register(s). Default: ignore features.
84 virtual void set_feature(Features){}
86 Does this equal or contain a certain register?
88 virtual bool contains_b(Request_register*reg_l)const;
90 Get information on the staff. Default: ask daddy.
92 virtual Staff_info get_staff_info();
95 virtual void do_print()const;
97 /** Every Request_register (except for the 'top' which is directly
98 inside the Staff_walker, is a element of a group. */
99 Register_group_register * daddy_reg_l_;
102 virtual ~Request_register(){}
103 NAME_MEMBERS(Request_register);
108 A macro to automate administration of registers.
110 #define ADD_THIS_REGISTER(c) \
112 static Request_register * globalctor (){ \
116 add_request_register(c::static_name(), globalctor); \
121 typedef Request_register*(*Reg_ctor)(void);
122 void add_request_register(String s, Reg_ctor f);
124 #endif // REGISTER_HH