CppUmlClass 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97066304da32e03a47c7374677dca591a3b0df8774157841bb027517aa91e4ed
-  data.tar.gz: af67ea7ce70c62059acb50241059c38aefc076543ac0d342192381e607b48909
+  metadata.gz: 8e2cce57ea7d1f32941bb2bb012fe8a3c7786b1fa943aefb84a6060bf61aa934
+  data.tar.gz: 2df23ba7d848da1c4b57c1d1d2f44feacd648880934def6abba4cc25014bca77
 SHA512:
-  metadata.gz: de6f569bdae61398778cd37a5c38fcc3c118c2f28e85ca7ec6e55faa594f2498935a65ba91b5d4fae9974674ca11688e60681f6a07e73318f3108d2cf0ab421c
-  data.tar.gz: 2a4422681c8b87fed14957172535b6bd605b5b6b9daf3937cfbf8024e268e6903f10e1ba29c195d9795e03645e11f4705d92bfbfd9cef36b0ae513a88d22c9e1
+  metadata.gz: f446514ce61a3722ff9db2311e088c547506099fef34e3a85283892d0c301924511f0db6be00f36a0f71bf02c75eaa15bac4eb7b8e386ea9147c05bbd3d80473
+  data.tar.gz: 8f4fcf4f7784e87b1bd67e5c1d416033bbd97b0811ef535e1f0723574b30a9531595c759930fd5fd2509dbb6c40f5e4241bff0c472dc9012b102020093605b29

data/README.md

@@ -1,75 +1,115 @@
 # CppUmlClass
 
-CppUmlClass creates a C++ class diagram.  
-PlantUML and rufo commands are used to create class diagrams.  
-The created class diagram is displayed on the browser screen.  
+CppUmlClass generates C++ class diagrams from your source code.  
+It uses PlantUML and rufo commands to create the diagrams, which are displayed in your browser.  
 
-## ruby setup
-    for ubuntu
-    $ sudo apt install ruby ruby-all-dev
+---
+
+## Version 1.0.0 Highlights
+
+- **Full support for ifdef/ifndef/if/else/elif/endif preprocessor directives**
+  - New: `lib/ifdef_process.rb` allows flexible interpretation of C/C++ preprocessors, reflected in UML analysis.
+- **Flexible define management with `define_hash`**
+  - You can control defines and their values for analysis via the `define_hash` in the settings file (`setting.json`). This can be edited from the GUI as well.
+- **Enhanced settings dialog and configuration management**
+  - Improved settings dialog with more intuitive editing, saving, and loading.
+- **Modernized UI/UX**
+  - Major updates to CSS, HTML, and JS provide a modern look, responsive design, and improved usability.
+- **WebSocket server and log output improvements**
+  - Flexible port settings and real-time, improved logging/progress display.
+
+---
+
+## Ruby Setup
+
+For Ubuntu:
+```sh
+$ sudo apt install ruby ruby-all-dev
+```
     
 ## CppUmlClass Setup
-    for ubuntu
-    $ sudo apt install chromium-browser
-    $ sudo apt install plantuml
-    $ sudo apt install clang-format
-    $ sudo apt install gcc
+
+For Ubuntu:
+```sh
+$ sudo apt install chromium-browser
+$ sudo apt install plantuml
+$ sudo apt install clang-format
+$ sudo apt install gcc
+```
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Add the gem to your application's Gemfile by running:
+
+```sh
+$ bundle add CppUmlClass
+```
 
-    $ bundle add CppUmlClass
+If you are not using bundler, install the gem directly:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```sh
+$ sudo gem install CppUmlClass
+```
 
-    $ sudo gem install CppUmlClass
+## Usage (GUI)
 
-## Usage(GUI)
-A browser-based GUI opens.
+A browser-based GUI will open:
 
-    $ start_cpp_uml_class.rb
-    
-https://github.com/user-attachments/assets/dfd68556-bf4d-43b7-8fef-b6f951c9147d
+```sh
+$ start_cpp_uml_class.rb
+```
+
+https://github.com/user-attachments/assets/d30ff495-5cee-4431-b35b-4c22f630ca22
+
+## Usage (Command Line)
+
+You can also use the command line interface:
 
-## Usage(command line)
-command line interface
 ```
 Usage: create_cpp_uml_class.rb [options] cpp_source_directory out_file
     -c config_file
 ```
-config_file defaults to CppUmlClass/config/setting.json in your home directory.
+The config_file defaults to `CppUmlClass/config/setting.json` in your home directory.
 
-Example
+Example:
 
-    $ create_cpp_uml_class.rb ~/tool/cpp_test /tmp/test.pu
+```sh
+$ create_cpp_uml_class.rb ~/tool/cpp_test /tmp/test.pu
+```
 
+---
 
-## clsss color support
+## Class Color Support
 
 ![class_color](img/class_color.png)
 
-## Setting
-
-- plant uml command
-- editor to open plant uml file
-- default class color 1
-- source path of the class that sets the color 1
-- default class color 2
-- source path of the class that sets the color 2
-- default class color 3
-- source path of the class that sets the color 2
-- exclude path    
-
-The setting file is saved in the home directory under CppUmlClass/config/setting.json.
+## Settings
+
+- PlantUML command
+- Editor command for PlantUML files
+- Default class color 1 and source path for color 1
+- Default class color 2 and source path for color 2
+- Default class color 3 and source path for color 3
+- Exclude path
+- define_hash
+
+The settings file is stored at `CppUmlClass/config/setting.json` in your home directory.
+
+**Example for define_hash:**
+```json
+{
+  "TEST3": true,
+  "DEBUG": 1,
+  "TEST_FUNC": true
+}
+```
 
 ![setting](img/setting.png)
 
-
-
 ## Development
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem locally, run `bundle exec rake install`.  
+To release a new version, update the version in `version.rb`, then run `bundle exec rake release` (this creates a git tag, pushes commits and tags, and uploads the `.gem` file to [rubygems.org](https://rubygems.org)).
 
 ## Contributing
 
@@ -77,4 +117,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/kuwaya
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+---
+

data/exe/create_cpp_uml_class.rb

@@ -37,11 +37,13 @@ end
 json_config = config_json_hash(json)
 
 file = "#{dir}/lib/create_uml_class.rb"
-puts file
+load file
+file = "#{dir}/lib/ifdef_process.rb"
 load file
 
 @config = json_config
-uml = create_uml_class(in_dir, out_file)
+pifdef = IfdefProcess.new
+uml = create_uml_class(pifdef, in_dir, out_file)
 
 File.open(out_file, "w") do |f|
   f.puts uml

data/lib/CppUmlClass/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CppUmlClass
-  VERSION = "0.9.0"
+  VERSION = "1.0.0"
 end

data/lib/config/setting.json

@@ -1,5 +1,5 @@
 {
-  "version": 0.2,
+  "version": 0.3,
   "setting_list": [
     {
       "name": "plantuml",
@@ -66,10 +66,20 @@
     },
     {
       "name": "exclude_path",
-      "value": "(exclude_path)",
+      "value": "(build)",
       "type": "input",
       "select": "",
       "description": "除外するパス（正規表現）"
+    },
+    {
+      "name": "define_hash",
+      "value": {
+        "DEBUG": true,
+        "DEBUG_PRINT2": true
+      },
+      "type": "textarea",
+      "select": "",
+      "description": "定義するdefineのリスト<br>例:<br>{<br>  \"DEBUG\":true <br>  \"VERSION\":1<br>}"
     }
   ]
 }

data/lib/config.ru

@@ -102,6 +102,6 @@ configure do
 
 end
 
-#\ --port 38249
+#\ --port 38899
 
 run Sinatra::Application

data/lib/cpp_uml_class.rb

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
 require "server_app_base.rb"
 require "kconv"
-#require "create_uml_class.rb"
+require "create_uml_class.rb"
+require "ifdef_process"
 
 class CppUmlClass < AppMainBase
   def start(argv)
@@ -22,9 +23,9 @@ class CppUmlClass < AppMainBase
       out_svg = out_file.gsub(File.extname(out_file), "") + ".svg"
 
       # uml作成
-      load "create_uml_class.rb"
+      pifdef = IfdefProcess.new
 
-      uml = create_uml_class(in_dir, out_file)
+      uml = create_uml_class(pifdef, in_dir, out_file)
 
       File.open(out_file, "w") do |f|
         f.puts uml
@@ -41,6 +42,8 @@ class CppUmlClass < AppMainBase
         yield "exec error"
         yield cmd
       end
+
+      app_send("popup:0:終了しました。<br><hr>#{in_dir}<br>で使用されているifdefのリスト<br><hr> #{pifdef.define_list.sort.join("<br>")}")
     rescue
       puts $!
       puts $@

data/lib/create_uml_class.rb

@@ -3,6 +3,7 @@ $LOAD_PATH << File.dirname(File.expand_path(__FILE__))
 require "tempfile"
 require "facter"
 require "check_word"
+require "ifdef_process"
 
 CStruct = Struct.new(:type,
                      :name,
@@ -19,12 +20,12 @@ def get_gcc_path
     ENV["PATH"].split(";").each do |path|
       gcc_path = "#{path}\\gcc"
       if File.exists? gcc_path
-        return "rubyw " + gcc_path + " -fpreprocessed -dD -E "
+        return "rubyw " + gcc_path + "w1 "
       end
     end
     return ""
   else
-    return "gcc -fpreprocessed -dD -E "
+    return "gcc -fpreprocessed -E "
   end
 end
 
@@ -64,43 +65,29 @@ end
 # フォーマット変更(clang-format)
 # コメント削除(gcc)
 # ifdefの処理(unifdef)
-def update_source(file)
-  # コメント削除
-  gcc_out_file = Tempfile.open(["gcc", File.extname(file)])
-  #puts gcc_out_file.path
-  #puts "|#{get_gcc_path} #{file} > #{gcc_out_file.path}"
-  open("|#{get_gcc_path} #{file} > #{gcc_out_file.path}") do |f|
-    if f.read =~ /error/
-      puts "gcc error #{f}"
-      return ""
-    end
-  end
-  #puts File.binread gcc_out_file.path
+def update_source(pifdef, file)
+  #puts "update_source=#{file}"
   # clang-format
   format_out_file = Tempfile.open(["clang_format", File.extname(file)])
-  #puts format_out_file.path
-  #puts "|#{get_clang_format_path} #{gcc_out_file.path} > #{format_out_file.path}"
-  open("|#{get_clang_format_path} #{gcc_out_file.path} > #{format_out_file.path}") do |f|
+  open("|#{get_clang_format_path} #{file} > #{format_out_file.path}") do |f|
     if f.read =~ /No such/
-      puts "gcc error #{f}"
+      puts "clang-format error #{f}"
       return ""
     end
   end
-  buf = File.binread format_out_file.path
-  return buf
-  # ifdef処理
-  unifdef_out_file = Tempfile.open(["gcc", File.extname(file)])
-  #puts unifdef_out_file.path
-  #puts "|#{get_unifdef_path} #{format_out_file.path} > #{unifdef_out_file.path}"
-  open("|#{get_unifdef_path} #{gcc_out_file.path} > #{unifdef_out_file.path}") do |f|
-    if f.read =~ /No such/
+  # コメント削除
+  gcc_out_file = Tempfile.open(["gcc", File.extname(file)])
+  open("|#{get_gcc_path} #{format_out_file.path} > #{gcc_out_file.path}") do |f|
+    if f.read =~ /error/
       puts "gcc error #{f}"
       return ""
     end
   end
-  buf = File.binread unifdef_out_file.path
-  puts buf
-  return buf
+  buf = File.binread gcc_out_file.path
+  #puts buf
+  # ifdef処理
+  out_buf = pifdef.process_ifdef(buf, @config["define_hash"])
+  return out_buf.join("\n")
 end
 
 def print_uml(out, out_list)
@@ -110,7 +97,7 @@ def print_uml(out, out_list)
     elsif o_list.type == :module_start
       out.push "namespace #{o_list.name} {"
     elsif o_list.type == :class_end
-      pp o_list if o_list.name == ""
+      #pp o_list if o_list.name == ""
       out.push "class #{o_list.name} #{o_list.class_color}{"
       # インスタンス変数の出力
       o_list.var_list.uniq.each do |iv|
@@ -135,7 +122,7 @@ def print_uml(out, out_list)
          o_list.method_list.size != 0 or
          o_list.inherit_list.size != 0 or
          o_list.composition_list.size != 0
-        pp o_list if o_list.name == ""
+        #pp o_list if o_list.name == ""
         out.push "class #{o_list.name} {"
         # インスタンス変数の出力
         o_list.var_list.uniq.each do |iv|
@@ -164,16 +151,16 @@ def print_uml(out, out_list)
   return out
 end
 
-def composition_list_create(in_dir, out_list)
+def composition_list_create(pifdef,in_dir, out_list)
   # composition_list
-  Dir.glob("#{in_dir}/**/*.{h,cpp,hpp}") do |file|
+  Dir.glob("#{in_dir}/**/*.{h,cpp,hpp,cc}") do |file|
     if @config["exclude_path"].to_s != "" and file =~ Regexp.new(@config["exclude_path"])
       #puts "skip #{file}"
       next
     end
-    #puts file
+    #puts "file=#{file}"
     # ソースコードの整形
-    buf = update_source(file)
+    buf = update_source(pifdef, file)
     # ソースを解析
     cstruct_list = []
     block_count = 0
@@ -260,7 +247,7 @@ def composition_list_create(in_dir, out_list)
   return out_list
 end
 
-def create_uml_class(in_dir, out_file)
+def create_uml_class(pifdef, in_dir, out_file)
   out = []
   out.push "@startuml"
 
@@ -278,7 +265,7 @@ def create_uml_class(in_dir, out_file)
     end
     #puts file
     # ソースコードの整形
-    buf = update_source(file)
+    buf = update_source(pifdef, file)
 
     cstruct_list = []
     block_count = 0
@@ -328,7 +315,7 @@ def create_uml_class(in_dir, out_file)
         elsif @config["class_color_path2"].to_s != "" and file =~ Regexp.new(@config["class_color_path2"])
           cstruct_list.push CStruct.new(:class_end, class_name, block_count, [], [], [], [], @config["class_color2"])
         elsif @config["class_color_path3"].to_s != "" and file =~ Regexp.new(@config["class_color_path3"])
-          pp file
+          #pp file
           cstruct_list.push CStruct.new(:class_end, class_name, block_count, [], [], [], [], @config["class_color3"])
         else
           cstruct_list.push CStruct.new(:class_end, class_name, block_count, [], [], [], [], @config["default_class_color"])
@@ -406,16 +393,17 @@ def create_uml_class(in_dir, out_file)
           cstruct_list.slice!(-1) # 最後の要素を削除
         end
       end
-      puts "#{block_count} #{line.chomp}"
+      #puts "#{block_count} #{line.chomp}"
     end
     if block_count != 0
       # エラー
+      puts "error block_count=#{block_count}"
       puts file
       return ""
     end
   end
   # compositon_listの作成
-  out_list = composition_list_create(in_dir, out_list)
+  out_list = composition_list_create(pifdef, in_dir, out_list)
   # UMLの出力
   out = print_uml(out, out_list)
 
@@ -440,39 +428,10 @@ def create_uml_class(in_dir, out_file)
   return out.join("\n")
 end
 
-def search_func(file)
-  #puts file
-  # ソースコードの整形
-  buf = update_source(file)
-  # ソースを解析
-  buf.each_line do |line|
-    next if line =~ /^[\r\n]*$/  # 空行は対象外
-    next if line =~ /^#/ # #から始まる行は対象外
-    #puts line
-    if line.gsub(/<.*>/, "") =~ /^\S.*(\S+)::(\S+).*\(.*{$/
-      #puts line.gsub!(/<.*>/, "")
-      line.match(/(\w+)(?=\S+\()/) do |m|
-        #puts "class_name=#{m}"
-      end
-    end
-  end
-end
-
 if $0 == __FILE__
-  #search_func(ARGV[0])
-  #exit
-  #buf = update_source(ARGV[0])
-  #puts buf
-  @config = { "exclude_path" => "" }
-
-  if true
-    puts create_uml_class(ARGV[0], ARGV[1])
-  else
-    out_list = []
-    out_list.push CStruct.new(:method_start, "DefaultVehicleHal", 1, [], [], [], [])
-    out_list.push CStruct.new(:method_start, "SubscriptionManager", 1, [], [], [], [])
-    out_list.push CStruct.new(:method_start, "ContSubConfigs", 1, [], [], [], [])
-    out_list.push CStruct.new(:method_start, "GetSetValuesClient", 1, [], [], [], [])
-    puts composition_list_create(ARGV[0], out_list)
-  end
+  @config = { "exclude_path" => "",
+"define_hash" => {} }
+  pifdef = IfdefProcess.new
+  puts create_uml_class(pifdef, ARGV[0], ARGV[1])
+  puts pifdef.define_list
 end