Class: Roby::YARD::EventHandler

Inherits:
YARD::Handlers::Ruby::Base
  • Object
show all
Defined in:
lib/roby/yard.rb

Instance Method Summary collapse

Instance Method Details

#processObject



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
# File 'lib/roby/yard.rb', line 129

def process
    name = statement.parameters[0].jump(:tstring_content, :ident).source

    controlable = false
    if statement.parameters[1]
        statement.parameters[1].jump(:assoc).to_a.each_slice(2) do |key, value|
            if key.source == "controlable:" || key.source == "command:"
                controlable = true
            end
        end
    end

    accessor = YARD::CodeObjects::MethodObject.new(namespace, "#{name}_event")
    register(accessor)
    register_group(accessor, "Task Events")
    accessor.docstring.add_tag(
        *YARD::Docstring.parser.create_tag("return", "[EventGenerator<#{name.camelcase(true)}>]"))

    happened = YARD::CodeObjects::MethodObject.new(namespace, "#{name}?")
    register(happened)
    register_group(happened, "Task Events")
    happened.docstring.add_tag(
        *YARD::Docstring.parser.create_tag("return", "[Boolean]"))

    if controlable
        command = YARD::CodeObjects::MethodObject.new(namespace, "#{name}!")
        register(command)
        register_group(command, "Task Events")
        command.parameters << %w[context nil]
    end

    push_state(scope: :class) do
        event_class = YARD::CodeObjects::ClassObject.new(
            namespace, name.camelcase(true).to_s
        )
        event_class.superclass = "Roby::Models::TaskEvent"
        register(event_class)
        event_class.docstring.replace(
            YARD::Docstring.new("Event class used to represent the events emitted by {#{namespace}##{name}_event}\n\n") +
            event_class.docstring)
    end
end