root/lang/ruby/misc/configpp/configpp.rb @ 9981

#!/usr/bin/ruby
#
#= configpp : Preprocessor for config files
#
#Authors::  Kouhei Ueno (nyaxt), ueno@nyaxtstep.com
#Version::  $Id$
#
#License::
# Copyright (c) 2007, Kouhei Ueno
# 
# All rights reserved.
# 
# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
# 
#     * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
#     * Neither the name of the nyaxtstep.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#

# 
# TODO:
#   - Refactoring! Refactoring! Refactoring!
#     - ConfigPP class should not handle command line options.
#

require 'optparse'
require 'tmpdir'
require 'erb'

module ConfigPP

  VERSION = "rev. #{'$Revision: 636 $'.split[1]}"

  module RuntimeEnv
    RUNTIMEENV = binding
  end

  class ConfigPP
    attr_accessor :options, :erb_trimming
    attr_accessor :overwrite, :out_filename, :out_dir, :diff # TODO: move these to appcontroller class when refactoring!

    def initialize
      @options = Hash.new
      @erb_trimming = '<>'

      @out_dir = Dir.pwd

      auto_detect_options
    end

    POSSIBLE_OS = ['win', 'cygwin', 'linux', 'osx', 'other']
    POSSIBLE_DIST = ['debian', 'zaurus', 'other']

    # parse command line options
    #
    # _argv_ :: pass ARGV here
    #
    # return :: argv without parsed options
    #
    # raise :: when parse failed
    #
    def parse_options argv=ARGV
      opt = OptionParser.new('configpp : preprocessor for config files')
      opt.version = VERSION

      opt.on('-o FILE', '--out-file FILE', 'set output file name') do |v|
        @out_filename = v
      end

      opt.on('--out-dir DIR', 'set output directory') do |v|
        raise "no such dir: #{v}" unless File.exists?(v)        
        raise "not directory: #{v}" unless File.ftype(v) == 'directory'

        @out_dir = v
      end

      opt.on('--overwrite', 'overwrite output file') do |v|
        @overwrite = v
      end

      opt.on('-d', '--diff', 'view diff to current') do |v|
        @diff = v
      end

      opt.on('-t TRIMMINGOPT', '--trimming TRIMMINGOPT', "set trimming option for erb interpreter (defaults to '#{@erb_trimming}')") do |v|
        @erb_trimming = v
      end
      
      opt.on('--os=OS', "set operating system (#{POSSIBLE_OS.join('/')})", POSSIBLE_OS) do |v|
        @options[:os] = v
      end

      opt.on('--dist=DISTRIBUTION', "set distribution (#{POSSIBLE_DIST.join('/')})", POSSIBLE_DIST) do |v|
        @options[:dist] = v
      end

      opt.on('--ext KEY=VAL', 'set extended options', /^(\w+?)=(\S+)$/) do |v|
        @options[v[1]] = v[2]
      end

      ret = opt.parse(argv)

      raise 'both output directory and output filename is specified' if @out_filename && @out_dir

      ret
    end

    # auto detect standard options from running env.
    def auto_detect_options
      @options[:dist] = 'other'

      # handle win env separately
      if RUBY_PLATFORM.match(/mswin/)
        @options[:os] = 'win'
        return
      end

      # detect os
      uname = `uname -a`

      @options[:os] = case uname
      when /cygwin/
        'cygwin'
      when /Darwin/
        'osx'
      when /Linux/
        'linux'
      else
        'other'
      end

      # detect linux distribution
      if @options[:os] == 'linux'
        @options[:dist] = case
        when File.exist?('/opt/QtPalmtop') # TODO: improve
          'zaurus'
        when File.exist?('/etc/debian_version')
          @options['debian_version'] = File.readlines("/etc/debian_version", nil)[0].chomp

          'debian'
        else
          'other'
        end
      end

    end

    # parse signature of a configpp sourcefile
    #
    # __filepath__ :: file to process
    def parse_signature(filepath)
      # first pass : parse configpp signature line
      filename = versioninfo = nil

      File.open(filepath, 'r') do |srcfile|
        srcfile.each_line do |line| 
          if match = line.match(/.*? configpp\s*:\s*(\S+)\s*,\s*(.*)$/)   
            filename = match[1]
            versioninfo = match[2]

            break
          end
        end
      end

      raise "configpp signature not found" unless filename and versioninfo

      [filename, versioninfo]
    end

    # process a configpp source file and write result to output file
    #
    # __filepath__ :: file to process
    def process(filepath, filename, versioninfo)
      # second pass : actually parse the file using erb
      
      evalenvklass = Class.new

      erb = ERB.new(File.readlines(filepath), nil, @erb_trimming) 
      erb.def_method(evalenvklass, '_process', File.basename(filepath))

      options = @options
      evalenv = evalenvklass.new
      evalenv.instance_eval do
        @cpp = ConfigPPUtil.new(filename, versioninfo, options)
      end

      evalenv._process
    end

  end

  class ConfigPPUtil

    # initialize ConfigPP runtime utils
    #
    # __filename__ : recommended output filename
    # __version__ : version str
    # __options__ : options hash
    #
    def initialize(filename, version, options)
      @filename = filename
      @version = version
      @options = options
      @commentprefix = '# '
    end
    
    def method_missing(name, *args)
      res_sym = @options[name]
      res_sym ? res_sym : @options[name.to_s]
    end

    # print header str
    def header
      headerstr =<<END
        Generated by configpp #{VERSION} on: #{Time.now.to_s}
        Using options: #{@options.inspect}
END

      headerstr.split($/).map {|line| @commentprefix + line.match(/^\s+(.*)/)[1]}.join("\n")+"\n"
    end

  end

end

if __FILE__ == $0
  configpp = ConfigPP::ConfigPP.new

  files = nil
  begin
    files = configpp.parse_options(ARGV)
    STDERR.puts "options : #{configpp.options.inspect}"
    raise "no file was given" if files.empty?
  rescue
    STDERR.puts "exception while parsing options: #{$!.to_s}"
    STDERR.puts
    configpp.parse_options(["--help"])
    exit 1
  end

  files.each do |path|
    next if File.ftype(path) != 'file'

    STDERR.puts "processing file: #{path}"
    begin
      if configpp.diff
        p tmpfile = Dir::tmpdir + "/configpptmp"

        filename, versioninfo = *configpp.parse_signature(path)

        output = configpp.process(path, filename, versioninfo)

        File.open(tmpfile, 'w') do |outfile|
          outfile.write output
        end

        orig_filename = configpp.out_filename 
        orig_filename = File.expand_path(filename, configpp.out_dir) unless orig_filename

        exec "diff -c #{orig_filename} #{tmpfile}"
      else
        filename, versioninfo = *configpp.parse_signature(path)

        out_filename = configpp.out_filename unless out_filename
        out_filename = File.expand_path(filename, configpp.out_dir) unless out_filename
        
        raise "output file already exists : #{out_filename}" if File.exists?(out_filename) and not (configpp.overwrite or configpp.diff)

        output = configpp.process(path, filename, versioninfo)

        File.open(out_filename, 'w') do |outfile|
          outfile.write output
        end
      end
    rescue
      STDERR.puts "error: #{$!.to_s}"
      STDERR.puts $!.backtrace.map {|e| "\t"+e}.join("\n")
    end
  end

  STDERR.puts "done!"

end