URL https://opencores.org/ocsvn/soc_maker/soc_maker/trunk

Subversion Repositories soc_maker

[/] [soc_maker/] [trunk/] [lib/] [soc_maker/] [cli.rb] - Blame information for rev 7

Go to most recent revision | Details | Compare with Previous | View Log


#!/usr/bin/env ruby
###############################################################
#
#  File:      soc_maker_cli.rb
#
#  Author:    Christian Hättich
#
#  Project:   System-On-Chip Maker
#
#  Target:    Linux / Windows / Mac
#
#  Language:  ruby
#
#
###############################################################
#
#
#   Copyright (C) 2014  Christian Hättich  - feddischson [ at ] opencores.org
#
#   This program is free software: you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation, either version 3 of the License, or
#   (at your option) any later version.
#
#   This program is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#   GNU General Public License for more details.
#
#   You should have received a copy of the GNU General Public License
#   along with this program.  If not, see .
#
#
###############################################################
#
#   Description:
#
#     Command-line interface for accessing the SOC-Maker functionallity
#
#     The following commands are available:
#       - new         -> create a new soc file
#       - open        -> open soc file
#       - list        -> list library
#       - add         -> add core to soc
#       - parameter   -> set/get parameter
#       - sparameter  -> set/get static parameter
#       - connect     -> connect cores
#       - delete      -> delete core or connection
#       - save        -> save soc
#       - generate    -> generate soc
#       - quit        -> quit this CLI
#       - exit        -> same than quit
#       - help        -> print some help
#
#     Please use the help command to get more information about
#     each command and its parameters.
#
#     This CLI is a wrapper around SOCMaker::SOCDef.
#
#
#######
#
# TODO: add commands for
#       - selecting the coder
#         (at the moment, only VHDL is supported)
#
#       - refreshing the lib
#
#
###############################################################
require 'readline'
require 'optparse'
 
 
module SOCMaker
class Cli
 
  private_class_method :new
  def Cli.instance
      @@inst = new if @@inst == nil
      return @@inst
  end
 
  FMSG      = ' -> failed '
 
 
 
  #########################################
  #
  # command implementations:
  #   -> a usage string and
  #      a function for every command
  #
 
  #
  # New
  #
  NEW_USAGE =
  "  > new <> <> <>   # opens a system-on-chip file
         - <>     : the SOC name
         - <>  : the SOC version
         - <> : the toplevel name
  "
  def do_new( args )
    if args.size != 3
      puts "three arguments are required:\nusage:\n#{NEW_USAGE}"
    else
      @soc = SOCMaker::SOCDef.new( args[0], args[1], args[2] )
      SOCMaker::lib.add_core( @soc )
      @soc_inst = SOCMaker::CoreInst.new( "#{args[0]}#{args[1]}" )
      #puts FMSG if @soc.load_soc( args[ 0 ] ) == nil
    end
  end
 
 
 
  #
  # Open
  #
  OPEN_USAGE =
  "  > open <>    # opens a system-on-chip file
         - <>    : system-on-chip definition in in YAML format
 
  "
  def do_open( args )
    if args.size != 1
      puts "only one argument is required:\nusage:\n#{OPEN_USAGE}"
    else
      puts "loading #{args[0]}"
      @soc = SOCMaker::from_f( args[0] )
      SOCMaker::lib.add_core( @soc )
      @soc_inst = SOCMaker::CoreInst.new( "#{@soc.name}#{@soc.version}" )
      #puts FMSG if @soc.load_soc( args[ 0 ] ) == nil
    end
  end
 
 
  #
  # List
  #
  LIST_USAGE =
  "  > list             # prints list of cores and interfaces,
                          which are in the library
 
  "
  def do_list( args )
    puts SOCMaker::lib
  end
 
 
  #
  # Add
  #
  ADD_USAGE =
  "  > add <> <> <>
                        # adds a ip-core from the library to the SOC
        - <>      : name of the IP core
        - <>   : version of the IP core
        - <>      : instanciation name
 
  "
  def do_add( args )
    if args.size != 3
      puts "three arguments are required:\nusage:\n#{ADD_USAGE}"
    else
      puts FMSG if @soc.add_core( args[ 0 ], args[ 1 ], args[ 2 ] ) == nil
    end
  end
 
 
  #
  # Set/Get Parameter
  #
  PARAMETER_USAGE =
  "  > prameter <> <> <>
                        # modifies a parameter of an instance
       - <>   : the instance name of the core
       - <>  : the instance parameter name
       - <>      : the value which is set (optional). The current
                          value is printed, if omitted
  "
  def do_parameter( args )
    if args.size == 2
      puts FMSG if @soc.get_param( args[ 0 ], args[ 1 ] ) == nil
    elsif args.size == 3
      puts FMSG if @soc.set_param( args[ 0 ], args[ 1 ], args[ 2 ] ) == nil
    else
      puts "two or three arguments required:\nusage:\n#{PARAMETER_USAGE}"
    end
  end
 
 
  #
  # Set/Get Static Parameter
  #
  SPARAMETER_USAGE =
  "  > sprameter <> <> <>
                        # modifies the static parameter of a core
       - <>       : the name of the core
       - <>  : the static parameter name
       - <>      : the value which is set (optional). The current
                          value is printed, if omitted
  "
  def do_sparameter( args )
    if args.size == 2
      puts FMSG if @soc.get_sparam( args[ 0 ], args[ 1 ] ) == nil
    elsif args.size == 3
      puts FMSG if @soc.set_sparam( args[ 0 ], args[ 1 ], args[ 2 ] ) == nil
    else
      puts "two or three arguments required:\nusage:\n#{SPARAMETER_USAGE}"
    end
  end
 
 
  #
  # Connect
  #
  CONNECT_USAGE =
  "  > connect <> <> <> <> <>
                        # connects two cores
        - <>     : instance name of the first core
        - <>     : instance name of the second core
        - <>      : interface name of the first core
        - <>      : interface name of the second core
        - <>      : connection name
 
  "
  def do_connect( args )
    if args.size != 5
      puts "five arguments are required:\nusage:\n#{CONNECT_USAGE}"
    else
      puts FMSG if @soc.add_connection( args[ 0 ], args[ 1 ], args[ 2 ], args[ 3 ], args[ 4 ] )
    end
  end
 
 
  #
  # Delete
  #
  DELETE_USAGE =
  "  > delete <>
                        # removes a core or a connection
        - < : the core or connection, which is removed
 
  "
  def do_delete( args )
    if args.size != 1
      puts "five arguments are required:\nusage:\n#{DELETE_USAGE}"
    else
      puts FMSG if @soc.rm( args[ 0 ] ) == nil
    end
  end
 
 
  #
  # Save
  #
  SAVE_USAGE =
  "  > save <>    # saves system-on-chip definition in YAML format to file
        - <>     : optional destination file, when omitted: the
                         original file-path is used
 
  "
  def do_save( args )
    if args.size > 1
      puts "zero or one argument is required:\nusage:\n#{SAVE_USAGE}"
    else
      p args
      puts FMSG if @soc.save_yaml( args ) == nil
    end
  end
 
 
  #
  # Generate
  #
  GENERATE_USAGE =
  "  > generate         # generates a synthesizable system-on-chip implementation
 
  "
  def do_generate( args )
    if args.size != 0
      puts "no arguments are required:\nusage:\n#{GENERATE_USAGE}"
    else
      @soc_inst.gen_toplevel
      @soc.copy_files
    end
  end
 
 
 
  PRINT_USAGE =
  "  > print            # prints SOC information
 
  "
  def do_print( args )
    if args.size != 0
      puts "no arguments are required:\nusage:\n#{PRINT_USAGE}"
    else
      puts @soc
    end
  end
 
 
  #
  # Quit
  #
  QUIT_USAGE =
  "  > quit             # the same than exit
 
  "
  def do_quit( args )
    do_exit( args )
  end
 
 
  #
  # Exit
  #
  EXIT_USAGE =
  "  > exit             # exits this tool
 
  "
  def do_exit( args )
    puts "... bye bye!"
    exit 0
  end
 
 
  #
  # Help
  #
  HELP_USAGE =
  "  > help             # prints some help information
 
  "
  def do_help( args )
    puts "The following commands are available:\n\n"
    @commands.each { |c| eval "puts  #{c.upcase}_USAGE" }
  end
 
 
  SET_USAGE =
  "  > set              # not implemented yet
 
  "
  def do_set( args )
    puts "NOT IMPLEMENTED, YET"
  end
 
  GET_USAGE =
  "  > get              # not implemented yet
 
  "
  def do_get( args )
    puts "NOT IMPLEMENTED, YET"
  end
 
  #  end command implementations
  #
  #################################
 
 
 
  @soc      = nil
  @soc_inst = nil
 
  def initialize
 
    # appreviation map
    @appr_map = { 'n' => "new",
                  'o' => "open",
                  'q' => "quit",
                  'h' => "help",
                  'l' => "list",
                  'a' => "add",
                  'g' => "generate",
                  's' => "save",
                  'p' => "parameter",
                  'd' => "delete",
                  'c' => "connect",
                  'i' => "print",
                  'x' => "exit"
                  }
 
    # all available commands
    @commands = %w[ new open list add parameter sparameter
                    delete connect save help quit exit
                    generate print set get ]
 
    comp = proc { |s| (@commands + Dir.entries( Dir.pwd )).grep( /^#{Regexp.escape(s)}/ ) }
    Readline.completion_append_character = " "
    Readline.completion_proc = comp
 
  end
 
  def run
 
    ##
    # process user commands
    #
    while buf = Readline.readline( "> ", true )
      process_cmd buf
    end
  end
 
  def process_cmd( c )
 
      # remove the comments and split each line
      match = SOCMaker::conf[ :COMMENT_REGEX ].match( c )
      cmd_arr = match[1].split( ' ' )
 
      # process the command, if there is one
      if cmd_arr.size > 0
        cmd     = ""
        if cmd_arr[ 0 ].size == 1 and @appr_map[ cmd_arr[ 0 ] ] != nil
          cmd = @appr_map[ cmd_arr[ 0 ] ]
        else
          cmd = cmd_arr[ 0 ]
        end
 
        if @commands.include?( cmd )
          cmd_str = "do_#{cmd}( cmd_arr[ 1..-1] )"
          puts "evaluating >>#{cmd_str}<< "
          eval( cmd_str )
        #TODO this is for linux only
        elsif system( "which #{cmd} > /dev/null 2>&1" )
          system( c )
        else
          puts "Command #{cmd} not available"
        end
       #begin
       #rescue
       #  puts "evaluating >>#{cmd_str}<< failed"
       #end
      end
  end
 
  @@inst = nil
 
 
end
end
 
 
# vim: noai:ts=2:sw=2
 

Browse

Tools

Subversion Repositories soc_maker

[/] [soc_maker/] [trunk/] [lib/] [soc_maker/] [cli.rb] - Blame information for rev 7

Line No.	Rev	Author	Line
1	3	feddischso	`#!/usr/bin/env ruby`
2			`###############################################################`
3			`#`
4			`# File: soc_maker_cli.rb`
5			`#`
6			`# Author: Christian Hättich`
7			`#`
8			`# Project: System-On-Chip Maker`
9			`#`
10			`# Target: Linux / Windows / Mac`
11			`#`
12			`# Language: ruby`
13			`#`
14			`#`
15			`###############################################################`
16			`#`
17			`#`
18			`# Copyright (C) 2014 Christian Hättich - feddischson [ at ] opencores.org`
19			`#`
20			`# This program is free software: you can redistribute it and/or modify`
21			`# it under the terms of the GNU General Public License as published by`
22			`# the Free Software Foundation, either version 3 of the License, or`
23			`# (at your option) any later version.`
24			`#`
25			`# This program is distributed in the hope that it will be useful,`
26			`# but WITHOUT ANY WARRANTY; without even the implied warranty of`
27			`# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the`
28			`# GNU General Public License for more details.`
29			`#`
30			`# You should have received a copy of the GNU General Public License`
31			`# along with this program. If not, see .`
32			`#`
33			`#`
34			`###############################################################`
35			`#`
36			`# Description:`
37			`#`
38			`# Command-line interface for accessing the SOC-Maker functionallity`
39			`#`
40			`# The following commands are available:`
41			`# - new -> create a new soc file`
42			`# - open -> open soc file`
43			`# - list -> list library`
44			`# - add -> add core to soc`
45			`# - parameter -> set/get parameter`
46			`# - sparameter -> set/get static parameter`
47			`# - connect -> connect cores`
48			`# - delete -> delete core or connection`
49			`# - save -> save soc`
50			`# - generate -> generate soc`
51			`# - quit -> quit this CLI`
52			`# - exit -> same than quit`
53			`# - help -> print some help`
54			`#`
55			`# Please use the help command to get more information about`
56			`# each command and its parameters.`
57			`#`
58			`# This CLI is a wrapper around SOCMaker::SOCDef.`
59			`#`
60			`#`
61			`#######`
62			`#`
63			`# TODO: add commands for`
64			`# - selecting the coder`
65			`# (at the moment, only VHDL is supported)`
66			`#`
67			`# - refreshing the lib`
68			`#`
69			`#`
70			`###############################################################`
71			`require 'readline'`
72			`require 'optparse'`
73
74
75			`module SOCMaker`
76			`class Cli`
77
78			`private_class_method :new`
79			`def Cli.instance`
80			`@@inst = new if @@inst == nil`
81			`return @@inst`
82			`end`
83
84			`FMSG = ' -> failed '`
85
86
87
88			`#########################################`
89			`#`
90			`# command implementations:`
91			`# -> a usage string and`
92			`# a function for every command`
93			`#`
94
95			`#`
96			`# New`
97			`#`
98			`NEW_USAGE =`
99			`" > new <> <> <> # opens a system-on-chip file`
100			`- <> : the SOC name`
101			`- <> : the SOC version`
102			`- <> : the toplevel name`
103			`"`
104			`def do_new( args )`
105			`if args.size != 3`
106			`puts "three arguments are required:\nusage:\n#{NEW_USAGE}"`
107			`else`
108			`@soc = SOCMaker::SOCDef.new( args[0], args[1], args[2] )`
109	6	feddischso	`SOCMaker::lib.add_core( @soc )`
110			`@soc_inst = SOCMaker::CoreInst.new( "#{args[0]}#{args[1]}" )`
111	3	feddischso	`#puts FMSG if @soc.load_soc( args[ 0 ] ) == nil`
112			`end`
113			`end`
114
115
116
117			`#`
118			`# Open`
119			`#`
120			`OPEN_USAGE =`
121			`" > open <> # opens a system-on-chip file`
122			`- <> : system-on-chip definition in in YAML format`
123
124			`"`
125			`def do_open( args )`
126			`if args.size != 1`
127			`puts "only one argument is required:\nusage:\n#{OPEN_USAGE}"`
128			`else`
129			`puts "loading #{args[0]}"`
130			`@soc = SOCMaker::from_f( args[0] )`
131	6	feddischso	`SOCMaker::lib.add_core( @soc )`
132			`@soc_inst = SOCMaker::CoreInst.new( "#{@soc.name}#{@soc.version}" )`
133	3	feddischso	`#puts FMSG if @soc.load_soc( args[ 0 ] ) == nil`
134			`end`
135			`end`
136
137
138			`#`
139			`# List`
140			`#`
141			`LIST_USAGE =`
142			`" > list # prints list of cores and interfaces,`
143			`which are in the library`
144
145			`"`
146			`def do_list( args )`
147			`puts SOCMaker::lib`
148			`end`
149
150
151			`#`
152			`# Add`
153			`#`
154			`ADD_USAGE =`
155			`" > add <> <> <>`
156			`# adds a ip-core from the library to the SOC`
157			`- <> : name of the IP core`
158			`- <> : version of the IP core`
159			`- <> : instanciation name`
160
161			`"`
162			`def do_add( args )`
163			`if args.size != 3`
164			`puts "three arguments are required:\nusage:\n#{ADD_USAGE}"`
165			`else`
166			`puts FMSG if @soc.add_core( args[ 0 ], args[ 1 ], args[ 2 ] ) == nil`
167			`end`
168			`end`
169
170
171			`#`
172			`# Set/Get Parameter`
173			`#`
174			`PARAMETER_USAGE =`
175			`" > prameter <> <> <>`
176			`# modifies a parameter of an instance`
177			`- <> : the instance name of the core`
178			`- <> : the instance parameter name`
179			`- <> : the value which is set (optional). The current`
180			`value is printed, if omitted`
181			`"`
182			`def do_parameter( args )`
183			`if args.size == 2`
184			`puts FMSG if @soc.get_param( args[ 0 ], args[ 1 ] ) == nil`
185			`elsif args.size == 3`
186			`puts FMSG if @soc.set_param( args[ 0 ], args[ 1 ], args[ 2 ] ) == nil`
187			`else`
188			`puts "two or three arguments required:\nusage:\n#{PARAMETER_USAGE}"`
189			`end`
190			`end`
191
192
193			`#`
194			`# Set/Get Static Parameter`
195			`#`
196			`SPARAMETER_USAGE =`
197			`" > sprameter <> <> <>`
198			`# modifies the static parameter of a core`
199			`- <> : the name of the core`
200			`- <> : the static parameter name`
201			`- <> : the value which is set (optional). The current`
202			`value is printed, if omitted`
203			`"`
204			`def do_sparameter( args )`
205			`if args.size == 2`
206			`puts FMSG if @soc.get_sparam( args[ 0 ], args[ 1 ] ) == nil`
207			`elsif args.size == 3`
208			`puts FMSG if @soc.set_sparam( args[ 0 ], args[ 1 ], args[ 2 ] ) == nil`
209			`else`
210			`puts "two or three arguments required:\nusage:\n#{SPARAMETER_USAGE}"`
211			`end`
212			`end`
213
214
215			`#`
216			`# Connect`
217			`#`
218			`CONNECT_USAGE =`
219			`" > connect <> <> <> <> <>`
220			`# connects two cores`
221			`- <> : instance name of the first core`
222			`- <> : instance name of the second core`
223			`- <> : interface name of the first core`
224			`- <> : interface name of the second core`
225			`- <> : connection name`
226
227			`"`
228			`def do_connect( args )`
229			`if args.size != 5`
230			`puts "five arguments are required:\nusage:\n#{CONNECT_USAGE}"`
231			`else`
232			`puts FMSG if @soc.add_connection( args[ 0 ], args[ 1 ], args[ 2 ], args[ 3 ], args[ 4 ] )`
233			`end`
234			`end`
235
236
237			`#`
238			`# Delete`
239			`#`
240			`DELETE_USAGE =`
241			`" > delete <>`
242			`# removes a core or a connection`
243			`- < : the core or connection, which is removed`
244
245			`"`
246			`def do_delete( args )`
247			`if args.size != 1`
248			`puts "five arguments are required:\nusage:\n#{DELETE_USAGE}"`
249			`else`
250			`puts FMSG if @soc.rm( args[ 0 ] ) == nil`
251			`end`
252			`end`
253
254
255			`#`
256			`# Save`
257			`#`
258			`SAVE_USAGE =`
259			`" > save <> # saves system-on-chip definition in YAML format to file`
260			`- <> : optional destination file, when omitted: the`
261			`original file-path is used`
262
263			`"`
264			`def do_save( args )`
265			`if args.size > 1`
266			`puts "zero or one argument is required:\nusage:\n#{SAVE_USAGE}"`
267			`else`
268			`p args`
269			`puts FMSG if @soc.save_yaml( args ) == nil`
270			`end`
271			`end`
272
273
274			`#`
275			`# Generate`
276			`#`
277			`GENERATE_USAGE =`
278			`" > generate # generates a synthesizable system-on-chip implementation`
279
280			`"`
281			`def do_generate( args )`
282			`if args.size != 0`
283			`puts "no arguments are required:\nusage:\n#{GENERATE_USAGE}"`
284			`else`
285	6	feddischso	`@soc_inst.gen_toplevel`
286	3	feddischso	`@soc.copy_files`
287			`end`
288			`end`
289
290
291	5	feddischso
292			`PRINT_USAGE =`
293			`" > print # prints SOC information`
294
295			`"`
296			`def do_print( args )`
297			`if args.size != 0`
298			`puts "no arguments are required:\nusage:\n#{PRINT_USAGE}"`
299			`else`
300			`puts @soc`
301			`end`
302			`end`
303
304
305	3	feddischso	`#`
306			`# Quit`
307			`#`
308			`QUIT_USAGE =`
309			`" > quit # the same than exit`
310
311			`"`
312			`def do_quit( args )`
313			`do_exit( args )`
314			`end`
315
316
317			`#`
318			`# Exit`
319			`#`
320			`EXIT_USAGE =`
321			`" > exit # exits this tool`
322
323			`"`
324			`def do_exit( args )`
325			`puts "... bye bye!"`
326			`exit 0`
327			`end`
328
329
330			`#`
331			`# Help`
332			`#`
333			`HELP_USAGE =`
334			`" > help # prints some help information`
335
336			`"`
337			`def do_help( args )`
338			`puts "The following commands are available:\n\n"`
339			`@commands.each { \|c\| eval "puts #{c.upcase}_USAGE" }`
340			`end`
341
342	5	feddischso
343			`SET_USAGE =`
344			`" > set # not implemented yet`
345
346			`"`
347			`def do_set( args )`
348			`puts "NOT IMPLEMENTED, YET"`
349			`end`
350
351			`GET_USAGE =`
352			`" > get # not implemented yet`
353
354			`"`
355			`def do_get( args )`
356			`puts "NOT IMPLEMENTED, YET"`
357			`end`
358
359	3	feddischso	`# end command implementations`
360			`#`
361			`#################################`
362
363
364
365	6	feddischso	`@soc = nil`
366			`@soc_inst = nil`
367	3	feddischso
368			`def initialize`
369
370			`# appreviation map`
371			`@appr_map = { 'n' => "new",`
372			`'o' => "open",`
373			`'q' => "quit",`
374			`'h' => "help",`
375			`'l' => "list",`
376			`'a' => "add",`
377			`'g' => "generate",`
378			`'s' => "save",`
379			`'p' => "parameter",`
380			`'d' => "delete",`
381			`'c' => "connect",`
382	5	feddischso	`'i' => "print",`
383	3	feddischso	`'x' => "exit"`
384			`}`
385
386			`# all available commands`
387			`@commands = %w[ new open list add parameter sparameter`
388			`delete connect save help quit exit`
389	5	feddischso	`generate print set get ]`
390	3	feddischso
391	5	feddischso	`comp = proc { \|s\| (@commands + Dir.entries( Dir.pwd )).grep( /^#{Regexp.escape(s)}/ ) }`
392	3	feddischso	`Readline.completion_append_character = " "`
393			`Readline.completion_proc = comp`
394
395			`end`
396
397			`def run`
398
399			`##`
400			`# process user commands`
401			`#`
402			`while buf = Readline.readline( "> ", true )`
403			`process_cmd buf`
404			`end`
405			`end`
406
407			`def process_cmd( c )`
408
409			`# remove the comments and split each line`
410			`match = SOCMaker::conf[ :COMMENT_REGEX ].match( c )`
411			`cmd_arr = match[1].split( ' ' )`
412
413			`# process the command, if there is one`
414			`if cmd_arr.size > 0`
415			`cmd = ""`
416			`if cmd_arr[ 0 ].size == 1 and @appr_map[ cmd_arr[ 0 ] ] != nil`
417			`cmd = @appr_map[ cmd_arr[ 0 ] ]`
418			`else`
419			`cmd = cmd_arr[ 0 ]`
420			`end`
421
422			`if @commands.include?( cmd )`
423			`cmd_str = "do_#{cmd}( cmd_arr[ 1..-1] )"`
424			`puts "evaluating >>#{cmd_str}<< "`
425			`eval( cmd_str )`
426			`#TODO this is for linux only`
427			`elsif system( "which #{cmd} > /dev/null 2>&1" )`
428			`system( c )`
429			`else`
430			`puts "Command #{cmd} not available"`
431			`end`
432			`#begin`
433			`#rescue`
434			`# puts "evaluating >>#{cmd_str}<< failed"`
435			`#end`
436			`end`
437			`end`
438
439			`@@inst = nil`
440
441
442			`end`
443			`end`
444
445
446			`# vim: noai:ts=2:sw=2`
447