Module: CommentStrip

Defined in:
lib/comment_strip/comment_strip.rb,
lib/comment_strip/strip.rb,
lib/comment_strip/version.rb

Overview

Main module for comment_strip.r library

Constant Summary collapse

VERSION =

Current version of the comment_strip.r library

'0.1.1'
VERSION_MAJOR =

Major version of the comment_strip.r library

VERSION_PARTS_[0]
VERSION_MINOR =

# Minor version of the comment_strip.r library

VERSION_PARTS_[1]
VERSION_REVISION =

# Revision version of the comment_strip.r library

VERSION_PARTS_[2]

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.strip(s, lf, **options) ⇒ Object

Strips comments from an input string, according to the rules and conventions of a given language-family

Signature

  • Parameters:

    • s (::String) the source code

    • lf (::String) the name of the language family. Currently only

      the value +'C'+ is accepted

    • options (::Hash) options that moderate the behaviour

  • Options:



59
60
61
62
63
64
65
66
67
68
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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
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
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/comment_strip/strip.rb', line 59

def self.strip s, lf, **options

    case lf.upcase
    when 'C'

        ;
    else

        raise "language family '#{lf}' unrecognised"
    end

    return nil if s.nil?
    return s if s.empty?

    line    =   0
    column  =   0

    state   =   :text

    r       =   ''

    cc_lines =   0

    s.each_char do |c|

        case c
        when ?\r, ?\n

            line += 1
            column = 0
        else

            column += 1
        end

        skip = false

        case c
        when ?\r, ?\n

            case state
            when :c_comment, :c_comment_star

                cc_lines += 1

                state = :c_comment
            when :cpp_comment

                state = :text
            when :sq_string, :sq_string_escape, :sq_string_closing

                state = :text
            when :dq_string_escape

                state = :dq_string
            when :slash_start

                r << '/'

                state = :text
            end
        else

            # special cases:
            #
            # - for escaped single/double quote
            # - for slash-start
            # - for comment-star

            case state
            when :sq_string_open

                state = (?\\ == c) ? :sq_string_escape : :sq_string_closing
            when :sq_string_escape

                state = :sq_string_closing
            when :dq_string_escape

                state = :dq_string
            when :c_comment_star

                case c
                when ?/

                    r << ?\n * cc_lines
                    cc_lines = 0

                    state = :text
                    skip = true
                when '*'

                    ;
                else

                    state = :c_comment
                end
            else

                if false
                elsif state == :slash_start && ('/' != c && '*' != c)

                    state = :text
                    r << '/'
                else

                    case c
                    when '/'

                        case state
                        when :text

                            state = :slash_start
                        when :slash_start

                            state = :cpp_comment
                        when :c_comment_star

                            r << ?\n * cc_lines
                            cc_lines = 0

                            state = :text
                            skip = true
                        end
                    when '*'

                        case state
                        when :slash_start

                            state = :c_comment
                        when :c_comment

                            state = :c_comment_star
                        else

                        end

                    when ?\'

                        case state
                        when :text

                            state = :sq_string_open
                        when :sq_string_closing

                            state = :text
                        else

                        end
                    when '"'

                        case state
                        when :text

                            state = :dq_string
                        when :dq_string

                            state = :text
                        else
                        end
                    when ?\\

                        case state
                        when :sq_string_open

                            state = :sq_string_escape
                        when :sq_string_escape

                            state = :sq_string
                        when :dq_string

                            state = :dq_string_escape
                        else

                        end
                    else

                        case state
                        when :sq_string_escape

                            state = :sq_string_closing
                        else

                        end
                    end
                end
            end
        end

        $stderr.puts "[#{line}, #{column}] state=#{state}, c=#{c} (#{c.ord}); skip=#{skip} [#cc lines: #{cc_lines}]\n" if $DEBUG

        case state
        when :slash_start
        when :cpp_comment
        when :c_comment
        when :c_comment_star

        else

            r << c unless skip
        end
    end

    r
end

Instance Method Details

#strip(s, lf, **options) ⇒ Object

Strips comments



265
266
267
268
 
# File 'lib/comment_strip/strip.rb', line 265

def strip s, lf, **options

    ::CommentStrip.strip s, lf, **options
end