Class: PuppetLint::Lexer::Token

Inherits:
Object
  • Object
show all
Defined in:
lib/puppet-lint/lexer/token.rb

Overview

Public: Stores a fragment of the manifest and the information about its location in the manifest.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type, value, line, column) ⇒ Token

Public: Initialise a new Token object.

type - An upper case Symbol describing the type of Token. value - The String value of the Token. line - The Integer line number where the Token can be found in the

manifest.

column - The Integer number of characters from the start of the line to

the start of the Token.

Returns the instantiated Token.



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/puppet-lint/lexer/token.rb', line 47

def initialize(type, value, line, column)
  @value = value
  @type = type
  @line = line
  @column = column
  @next_token = nil
  @prev_token = nil
  @next_code_token = nil
  @prev_code_token = nil
end

Instance Attribute Details

#column ⇒ Object (readonly)

Public: Returns the Integer column number of the line of the manifest text where the Token can be found.



21
22
23
 
# File 'lib/puppet-lint/lexer/token.rb', line 21

def column
  @column
end

#line ⇒ Object (readonly)

Public: Returns the Integer line number of the manifest text where the Token can be found.



17
18
19
 
# File 'lib/puppet-lint/lexer/token.rb', line 17

def line
  @line
end

#next_code_token ⇒ Object

Public: Gets/sets the next code token (skips whitespace, comments, etc) in the manifest.



31
32
33
 
# File 'lib/puppet-lint/lexer/token.rb', line 31

def next_code_token
  @next_code_token
end

#next_token ⇒ Object

Public: Gets/sets the next token in the manifest.



24
25
26
 
# File 'lib/puppet-lint/lexer/token.rb', line 24

def next_token
  @next_token
end

#prev_code_token ⇒ Object

Public: Gets/sets the previous code tokne (skips whitespace, comments, etc) in the manifest.



35
36
37
 
# File 'lib/puppet-lint/lexer/token.rb', line 35

def prev_code_token
  @prev_code_token
end

#prev_token ⇒ Object

Public: Gets/sets the previous token in the manifest.



27
28
29
 
# File 'lib/puppet-lint/lexer/token.rb', line 27

def prev_token
  @prev_token
end

#raw ⇒ Object

Public: Returns the raw value of the Token.



13
14
15
 
# File 'lib/puppet-lint/lexer/token.rb', line 13

def raw
  @raw
end

#type ⇒ Object

Public: Returns the Symbol type of the Token.



7
8
9
 
# File 'lib/puppet-lint/lexer/token.rb', line 7

def type
  @type
end

#value ⇒ Object

Public: Returns the String value of the Token.



10
11
12
 
# File 'lib/puppet-lint/lexer/token.rb', line 10

def value
  @value
end

Instance Method Details

#inspect ⇒ Object

Public: Produce a human friendly description of the Token when inspected.

Returns a String describing the Token.



62
63
64
 
# File 'lib/puppet-lint/lexer/token.rb', line 62

def inspect
  "<Token #{@type.inspect} (#{@value}) @#{@line}:#{@column}>"
end

#to_manifest ⇒ Object

Public: Produce a Puppet DSL representation of a Token.

Returns a Puppet DSL String.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/puppet-lint/lexer/token.rb', line 69

def to_manifest
  case @type
  when :STRING
    "\"#{@value}\""
  when :SSTRING
    "'#{@value}'"
  when :DQPRE
    "\"#{@value}"
  when :DQPOST
    "#{@value}\""
  when :VARIABLE
    if !@prev_code_token.nil? && [:DQPRE, :DQMID].include?(@prev_code_token.type)
      "${#{@value}}"
    else
      "$#{@value}"
    end
  when :UNENC_VARIABLE
    "$#{@value}"
  when :NEWLINE
    "\n"
  when :COMMENT
    "##{@value}"
  when :REGEX
    "/#{@value}/"
  when :MLCOMMENT
    @raw
  else
    @value
  end
end