class Format

Allows for C-like source code to be formatted using several popular bracketing styles.

@author Arcterus @version 2012-09-11

Public Class Methods

ALLMAN() click to toggle source

Allman bracketing style

@return [Integer] the number designating the

Allman bracketing style

# File lib/format.rb, line 166
def self.ALLMAN
    1
end

JAVA() click to toggle source

Java bracketing style

@return [Integer] the number designating the

Java bracketing style

# File lib/format.rb, line 186
def self.JAVA
    3
end

SUN() click to toggle source

(see ::JAVA)

# File lib/format.rb, line 193
def self.SUN
    self.JAVA
end

UNIX() click to toggle source

UNIX bracketing style

@return [Integer] the number designating the

UNIX bracketing style

# File lib/format.rb, line 176
def self.UNIX
    2
end

VERSION() click to toggle source

Gives the current version of format.

@return [String] the version of format

# File lib/format.rb, line 206
def self.VERSION
    if @@version == nil then
        file = File.dirname(__FILE__) + '/../VERSION'
        @@version = File.exists?(file) ? File.read(file) : ''
    end
    @@version
end

WHITESMITH() click to toggle source

# File lib/format.rb, line 197
def self.WHITESMITH
    4
end

format(file, options={}) click to toggle source

Formats the input file according to the input options.

@param [String] file the input file name @param [Hash] options the options that determine

what is to happen to the
input file

# File lib/format.rb, line 223
def self.format(file, options={})
    indent = options[:indentation]
    if indent == nil then
        indent = '    '
    end
    output = nil
    case options[:style]
    when self.ALLMAN
        output = File.new(file + '.allman', 'w+')
        self.allman(file, output, indent)
    when self.UNIX
        output = File.new(file + '.unix', 'w+')
        self.unix(file, output, indent)
    when self.JAVA
        output = File.new(file + '.sun', 'w+')
        self.java(file, output, indent)
    else
        puts 'Defaulting to Java style formatting...'
        output = File.new(file + '.sun', 'w+')
        self.java(file, output, indent)
    end
    output.close
end

Private Class Methods

allman(file, output, indent) click to toggle source

Format the input file using the Allman bracketing style.

@param [String] file the name of the input file @param [File] output the output file @param [String] indent the string to be used for

indentation

# File lib/format.rb, line 61
def self.allman(file, output, indent)
    typedef = false
    IO.readlines(file).each {|line|
        indentlevel = self.get_leading_space(line).scan(/#{Regexp.quote(indent)}/).size
        if line =~ /^[[:blank:]]*}.*$/ then
            indentlevel.times do
                output.print(indent)
            end
            output.puts('}')
            line.sub!(/}[[:blank:]]*/, '')
            next if line.lstrip == ''
        end
        if line =~ /[[:graph:]][[:blank:]]*{[[:blank:]]*$/ then
            output.puts(line.rstrip.chop.rstrip)
            indentlevel.times do
                output.print(indent)
            end
            output.puts('{')
        else
            output.puts(line)
        end
    }
end

get_leading_space(str) click to toggle source

Get the leading whitespace (the indentation) from the input string.

@param [String] str the string from which the

whitespace will be taken

@return [String] the leading whitespace

# File lib/format.rb, line 40
def self.get_leading_space(str)
    result = ''
    str.each_char {|ch|
        if ch.is_space then
            result += ch
        else
            break
        end
    }
    return result
end

java(file, output, indent) click to toggle source

Format the input file using the Java bracketing style.

@param [String] file the name of the input file @param [File] output the output file @param [String] indent the string to be used for

indentation

# File lib/format.rb, line 123
def self.java(file, output, indent)
    prev_line = 'IGNORE THIS LINE'
    data = IO.readlines(file)
    index = 0
    data.each {|line|
        if line =~ /^[[:blank:]]*{[[:blank:]]*$/ and
           !(prev_line =~ /^[[:blank:]]*}[[:blank:]]*$/) then
            prev_line = prev_line.rstrip + ' {'
            line = 'IGNORE THIS LINE'
        else
            @@keywords.each {|key|
                if line =~ /^[[:blank:]]*#{Regexp.quote(key)}([[:blank:]]|\()?.*$/ and
                   prev_line =~ /^[[:blank:]]*}[[:blank:]]*$/ then
                    prev_line = prev_line.rstrip + ' ' + line.lstrip
                    if index + 1 < data.length and
                       data[index + 1] =~ /^[[:blank:]]*{[[:blank:]]*$/ then
                        prev_line = prev_line.rstrip + ' {'
                        data[index + 1] = 'IGNORE THIS LINE'
                    end
                    line = 'IGNORE THIS LINE'
                    break
                end
            }
        end
        output.puts(prev_line) if prev_line != 'IGNORE THIS LINE'
        prev_line = line
        index += 1
    }
    output.puts(prev_line) if prev_line != 'IGNORE THIS LINE'
end

unix(file, output, indent) click to toggle source

Format the input file using the UNIX bracketing style.

@param [String] file the name of the input file @param [File] output the output file @param [String] indent the string to be used for

indentation

# File lib/format.rb, line 94
def self.unix(file, output, indent)
    java_output = File.new(file + '.unix.tmp', 'w+')
    self.java(file, java_output, indent)
    java_output.seek(0, IO::SEEK_SET)
    IO.readlines(java_output).each {|line|
        indentlevel = self.get_leading_space(line).scan(/#{Regexp.quote(indent)}/).size
        if line =~ /^[[:blank:]]*[[:alpha:]][[:alnum:]]*[[:blank:]]+.*\(.*\)[[:blank:]]*\{[[:blank:]]*$/ then
            output.puts(line.rstrip.chop.rstrip)
            indentlevel.times do
                output.print(indent)
            end
            output.puts('{')
        else
            output.puts(line)
        end
    }
    java_output.close
    File.delete(file + '.unix.tmp')
end

whitesmith(file, output, indent) click to toggle source

# File lib/format.rb, line 154
def self.whitesmith(file, output, indent)

end