Class: Discordrb::Commands::CommandChain

Inherits:
Object
  • Object
show all
Defined in:
lib/discordrb/commands/parser.rb

Overview

Command chain, may have multiple commands, nested and commands

Instance Method Summary collapse

Constructor Details

#initialize(chain, bot, subchain = false) ⇒ CommandChain

Returns a new instance of CommandChain.

Parameters:

  • chain (String)

    The string the chain should be parsed from.

  • bot (CommandBot)

    The bot that executes this command chain.

  • subchain (true, false) (defaults to: false)

    Whether this chain is a sub chain of another chain.


124
125
126
127
128
129
# File 'lib/discordrb/commands/parser.rb', line 124

def initialize(chain, bot, subchain = false)
  @attributes = bot.attributes
  @chain = chain
  @bot = bot
  @subchain = subchain
end

Instance Method Details

#execute(event) ⇒ String

Divides the command chain into chain arguments and command chain, then executes them both.

Parameters:

  • event (CommandEvent)

    The event to execute the command with.

Returns:

  • (String)

    the result of the command chain execution.


254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/discordrb/commands/parser.rb', line 254

def execute(event)
  old_chain = @chain
  @bot.debug 'Executing bare chain'
  result = execute_bare(event)

  @chain_args ||= []

  @bot.debug "Found chain args #{@chain_args}, preliminary result #{result}"

  @chain_args.each do |arg|
    case arg.first
    when 'repeat'
      new_result = ''
      executed_chain = divide_chain(old_chain).last

      arg[1].to_i.times do
        chain_result = CommandChain.new(executed_chain, @bot).execute(event)
        new_result += chain_result if chain_result
      end

      result = new_result      # TODO: more chain arguments

    end
  end

  result
end

#execute_bare(event) ⇒ String

Parses the command chain itself, including sub-chains, and executes it. Executes only the command chain, without its chain arguments.

Parameters:

  • event (CommandEvent)

    The event to execute the chain with.

Returns:

  • (String)

    the result of the execution.


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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'lib/discordrb/commands/parser.rb', line 135

def execute_bare(event)
  b_start = -1
  b_level = 0
  result = ''
  quoted = false
  escaped = false
  hacky_delim, hacky_space, hacky_prev, hacky_newline = [0xe001, 0xe002, 0xe003, 0xe004].pack('U*').chars

  @chain.each_char.each_with_index do |char, index|
    # Escape character
    if char == '\\' && !escaped
      escaped = true
      next
    elsif escaped && b_level <= 0
      result += char
      escaped = false
      next
    end

    if quoted      # Quote end

      if char == @attributes[:quote_end]
        quoted = false
        next
      end

      if b_level <= 0
        case char
        when @attributes[:chain_delimiter]
          result += hacky_delim
          next
        when @attributes[:previous]
          result += hacky_prev
          next
        when ' '
          result += hacky_space
          next
        when "\n"
          result += hacky_newline
          next
        end
      end
    else
      case char
      when @attributes[:quote_start] # Quote begin
        quoted = true
        next
      when @attributes[:sub_chain_start]
        b_start = index if b_level.zero?
        b_level += 1
      end
    end

    result += char if b_level <= 0

    next unless char == @attributes[:sub_chain_end] && !quoted
    b_level -= 1
    next unless b_level.zero?
    nested = @chain[b_start + 1..index - 1]
    subchain = CommandChain.new(nested, @bot, true)
    result += subchain.execute(event)
  end

  event.respond("Your subchains are mismatched! Make sure you don't have any extra #{@attributes[:sub_chain_start]}'s or #{@attributes[:sub_chain_end]}'s") unless b_level.zero?

  @chain = result

  @chain_args, @chain = divide_chain(@chain)

  prev = ''

  chain_to_split = @chain

  # Don't break if a command is called the same thing as the chain delimiter
  chain_to_split = chain_to_split.slice(1..-1) if !@attributes[:chain_delimiter].empty? && chain_to_split.start_with?(@attributes[:chain_delimiter])

  first = true
  split_chain = if @attributes[:chain_delimiter].empty?
                  [chain_to_split]
                else
                  chain_to_split.split(@attributes[:chain_delimiter])
                end
  split_chain.each do |command|
    command = @attributes[:chain_delimiter] + command if first && @chain.start_with?(@attributes[:chain_delimiter])
    first = false

    command = command.strip

    # Replace the hacky delimiter that was used inside quotes with actual delimiters
    command = command.gsub hacky_delim, @attributes[:chain_delimiter]

    first_space = command.index ' '
    command_name = first_space ? command[0..first_space - 1] : command
    arguments = first_space ? command[first_space + 1..-1] : ''

    # Append a previous sign if none is present
    arguments += @attributes[:previous] unless arguments.include? @attributes[:previous]
    arguments = arguments.gsub @attributes[:previous], prev

    # Replace hacky previous signs with actual ones
    arguments = arguments.gsub hacky_prev, @attributes[:previous]

    arguments = arguments.split ' '

    # Replace the hacky spaces/newlines with actual ones
    arguments.map! do |elem|
      elem.gsub(hacky_space, ' ').gsub(hacky_newline, "\n")
    end

    # Finally execute the command
    prev = @bot.execute_command(command_name.to_sym, event, arguments, split_chain.length > 1 || @subchain)
  end

  prev
end