Add devcontainer (#529)

Author: yutaro-sakamoto

.devcontainer/Dockerfile

@@ -0,0 +1,12 @@
+FROM almalinux:9
+
+SHELL ["/bin/bash", "-c"]
+
+# classpath settings
+ENV CLASSPATH :/usr/lib/opensourcecobol4j/libcobj.jar
+RUN echo 'export CLASSPATH=:/usr/lib/opensourcecobol4j/libcobj.jar' >> ~/.bashrc
+
+# install dependencies
+RUN dnf update -y
+RUN dnf install -y epel-release
+RUN dnf install -y gcc make bison flex automake autoconf diffutils gettext java-21-openjdk-devel git-clang-format cppcheck

.devcontainer/boot.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+# Build and Install
+./configure --prefix=/usr/
+make
+make install
+
+# Set up pre-commit hook
+cp .devcontainer/term_settings/pre-commit .git/hooks/pre-commit
+
+# Set up ~/.bashrc
+cat .devcontainer/term_settings/extra_bashrc.sh >> ~/.bashrc

.devcontainer/devcontainer.json

@@ -0,0 +1,7 @@
+{
+    "name": "opensource COBOL 4J development",
+    "build": {
+        "dockerfile": "Dockerfile"
+    },
+    "postCreateCommand": ".devcontainer/boot.sh && source ~/.bashrc"
+}

.devcontainer/term_settings/extra_bashrc.sh

@@ -0,0 +1,11 @@
+alias ls='ls --color=auto'
+alias ll='ls -l'
+alias la='ls -a'
+
+alias g='git'
+
+parse_git_branch() {
+     git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/ (\1)/'
+}
+
+export PS1="\e[0;32m[\w\[\033[33m\]\$(parse_git_branch)\[\033[00m\]\e[0;32m]\033[00m "

.devcontainer/term_settings/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+git add -u
+./format

.github/workflows/static-analysis.yml

@@ -9,8 +9,9 @@ permissions:
 jobs:
   static_analysis:
     runs-on: ubuntu-22.04
+    container:
+      image: almalinux:9
     steps:
-      # Checkout opensource COBOL
       - name: Checkout opensource COBOL 4J
         uses: actions/checkout@v4
 
@@ -21,19 +22,19 @@ jobs:
 
       - name: Install static analysis tools
         run: |
-          sudo apt-get update -y
-          sudo apt-get install -y clang-format cppcheck
+          dnf update -y
+          dnf install -y epel-release
+          dnf install -y gcc make bison flex automake autoconf diffutils gettext java-21-openjdk-devel git-clang-format cppcheck
 
       - name: Install opensource COBOL 4J
         run: |
-          sudo apt-get install -y build-essential bison flex gettext texinfo autoconf
           ./configure --prefix=/usr/
           make
-          sudo make install
+          make install
 
-      #- name: Check format with google-java-format and clang-format
-      #  run: |
-      #    ./check-format
+      - name: Check format with google-java-format and clang-format
+        run: |
+          ./check-format
 
       - name: Run SpotBugs
         working-directory: libcobj
@@ -45,7 +46,7 @@ jobs:
         run: |
           ./gradlew pmdMain
 
-      #- name: Run cppcheck
-      #  working-directory: cobj
-      #  run: |
-      #    ./cpp-check
+      - name: Run cppcheck
+        working-directory: cobj
+        run: |
+          ./cpp-check

CONTRIBUTING.md

@@ -12,12 +12,28 @@ The static analysis checks whether C and Java source files are formatted using [
 
 The below sections describe how to setup and run static code analysis.
 
-## Setup static analysis tools
+## Setup Development Environment
 
-Run `sudo apt install clang-format` in Ubuntu to install `clang-format`.
+We strongly recommend using [Visual Studio Code with Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) for a consistent development environment. Follow the steps below to set up your development environment.
+
+1. Install [Docker](https://www.docker.com/get-started) on your machine.
+1. Install [Visual Studio Code](https://code.visualstudio.com/).
+1. Install the [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension in Visual Studio Code.
+1. Clone the repository.
+1. Open the repository in Visual Studio Code.
+1. Press `Ctrl+Shift+P` and Select `Dev Containers: Reopen in Container`.
+1. Wait for the DevContainer to start up and the build to complete. It may take several minutes to complete this process.
+1. (Optional) Press `Ctrl+Shift+@` to open a new terminal of Visual Studio code.
+1. (Optional) [Setup credentials for git](https://code.visualstudio.com/remote/advancedcontainers/sharing-git-credentials).
+
+> [!CAUTION]
+> In the dev container, [Git Hooks](https://git-scm.com/book/ms/v2/Customizing-Git-Git-Hooks) executes code formatters when starting `git commit` command. It may take a minutes when you run `git commit` for the first time.
 
 ## Run static analysis
 
+> [!CAUTION]
+> CI executes formatters and static analysis tools in Almalinux 9. The behavior of these tools may differ from the one in other operatins systems.
+
 ### check with clang-format and google-java-format
 
 Run `./format` in the top directory of opensource COBOL 4J.

CONTRIBUTING_JP.md

@@ -12,12 +12,29 @@ CIの静的解析はCとJavaのソースコードがそれぞれ[clang-format](h
 
 下記にそれぞれのツールのセットアップと使用方法を説明します。
 
-## セットアップ
+## 開発環境のセットアップ
+
+一貫した開発環境を確保するために、[Visual Studio Code with Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers)の使用を強く推奨します。以下の手順に従って開発環境をセットアップしてください。
+
+1. [Docker](https://www.docker.com/get-started)をインストールします。
+1. [Visual Studio Code](https://code.visualstudio.com/)をインストールします。
+1. Visual Studio Codeに[Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)拡張機能をインストールします。
+1. リポジトリをクローンします。
+1. Visual Studio Codeでリポジトリを開きます。
+1. `Ctrl+Shift+P`を押して、`Dev Containers: Reopen in Container`を選択します。
+1. DevContainerの起動とビルドが完了するまで待ちます。このプロセスは数分かかることがあります。
+1. （オプション）`Ctrl+Shift+@`を押して、Visual Studio Codeの新しいターミナルを開きます。
+1. （オプション）[gitの認証情報を設定](https://code.visualstudio.com/remote/advancedcontainers/sharing-git-credentials)します。
+
+> [!CAUTION]
+> Dev container内では、[Git Hooks](https://git-scm.com/book/ms/v2/Customizing-Git-Git-Hooks)が`git commit`コマンドを開始する際にコードフォーマッタを実行します。初めて`git commit`を実行する際には数分かかることがあります。
 
-Ubuntuでは`sudo apt install clang-format`コマンドを実行すれば`clang-format`をインストールできます。
 
 ## 静的解析の実行
 
+> [!CAUTION]
+> CIはAlmalinux 9でフォーマッタと静的解析ツールを実行します。これらのツールの動作は他のオペレーティングシステムとは異なる場合があります。
+
 ### clang-formatとgoogle-java-format
 
 opensource COBOL 4Jのトップディレクトリで`./format`を実行してください。

check-format

@@ -1,3 +1,3 @@
 #!/bin/bash
-cd libcobj && ./gradlew verGJF
+cd libcobj && ./gradlew spotlessCheck
 cd ../cobj && ./check-format

cobj/codegen.c

@@ -87,7 +87,7 @@ extern unsigned char cb_default_byte;
 static int index_read_flag = 0;
 
 static struct label_list {
-  struct label_list *next;
+  // struct label_list *next;
   int id;
   int call_num;
 } *label_cache = NULL;
@@ -1416,10 +1416,8 @@ static void joutput_param(cb_tree x, int id) {
   cb_tree l;
   struct literal_list *ll;
   int n;
-  int extrefs;
   int sav_stack_id;
   char fname[12];
-  COB_UNUSED(extrefs);
 
   param_id = id;
 
@@ -1506,7 +1504,6 @@ static void joutput_param(cb_tree x, int id) {
     break;
   case CB_TAG_REFERENCE:
     r = CB_REFERENCE(x);
-    extrefs = 0;
     if (r->check) {
       joutput("(new GetAbstractCobolField() {");
       joutput_newline();
@@ -1578,7 +1575,6 @@ static void joutput_param(cb_tree x, int id) {
     }
     f = CB_FIELD(r->value);
     if (f->redefines && f->redefines->flag_external) {
-      extrefs = 1;
       f->flag_item_external = 1;
       f->flag_external = 1;
     }
@@ -1587,12 +1583,10 @@ static void joutput_param(cb_tree x, int id) {
     }
     for (pechk = f->parent; pechk; pechk = pechk->parent) {
       if (pechk->flag_external) {
-        extrefs = 1;
         f->flag_item_external = 1;
         break;
       }
       if (pechk->redefines && pechk->redefines->flag_external) {
-        extrefs = 1;
         f->flag_item_external = 1;
         f->flag_external = 1;
         break;
@@ -1979,7 +1973,7 @@ static void joutput_cond(cb_tree x, int save_flag) {
     joutput_indent("public int run(){");
     joutput_indent_level += 2;
     for (; x; x = CB_CHAIN(x)) {
-      //最後の文ならreturn文を書く
+      // 最後の文ならreturn文を書く
       if (!CB_CHAIN(x)) {
         joutput_indent("return ");
       }
@@ -6236,20 +6230,20 @@ void codegen(struct cb_program *prog, const int nested, char **program_id_list,
 
   /* Program local stuff */
 
-  //コンストラクタの実装コードを出力
-  //メンバ変数の初期化を行う
+  // コンストラクタの実装コードを出力
+  // メンバ変数の初期化を行う
   joutput_line("public %s()", prog->program_id);
   joutput_line("{");
   joutput_line("  init();");
   joutput_line("}");
   joutput_newline();
 
-  //メンバ変数の初期化メソッドを出力
+  // メンバ変数の初期化メソッドを出力
   create_sorted_data_storage_cache();
   joutput_init_method(prog);
   joutput_newline();
 
-  //メンバ変数の出力
+  // メンバ変数の出力
   joutput_declare_member_variables(prog, prog->parameter_list);
   joutput("\n");
 

cobj/cpp-check

@@ -5,4 +5,7 @@ cppcheck --error-exitcode=1 \
     --enable=performance \
     --enable=portability \
     --suppress=unusedFunctions \
-    --suppress=toomanyconfigs
+    --suppress=toomanyconfigs \
+    --suppress=unusedStructMember \
+    --suppress=leakNoVarFunctionCall \
+    --suppress=unreadVariable

cobj/ppparse.c

@@ -436,7 +436,7 @@ void *malloc(YYSIZE_T); /* INFRINGES ON USER NAME SPACE */
 #ifndef YYFREE
 #define YYFREE free
 #if !defined free && !defined EXIT_SUCCESS
-void free(void *);      /* INFRINGES ON USER NAME SPACE */
+void free(void *); /* INFRINGES ON USER NAME SPACE */
 #endif
 #endif
 #endif

cobj/tree.h

@@ -515,7 +515,7 @@ struct cb_field {
     cb_tree key; /* KEY */
     cb_tree ref; /* reference used in SEARCH ALL */
     cb_tree val; /* value to be compared in SEARCH ALL */
-  } * keys;
+  } *keys;
   int nkeys;              /* the number of keys */
   int param_num;          /* CHAINING param number */
   struct cb_picture *pic; /* PICTURE */

format

@@ -1,3 +1,3 @@
 #!/bin/bash
-cd libcobj && ./gradlew goJF
+cd libcobj && ./gradlew spotlessApply
 cd ../cobj && ./format

libcobj/app/build.gradle.kts

@@ -3,8 +3,8 @@ import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
 plugins {
     application
     id("com.github.johnrengelman.shadow") version "8.1.1"
+    id("com.diffplug.spotless") version "7.0.0.BETA4"
     id("java")
-    id("com.github.sherter.google-java-format") version "0.9"
     id("maven-publish")
     pmd
     id("com.github.spotbugs") version "6.0.25"
@@ -59,6 +59,12 @@ spotbugs {
     excludeFilter.set(project.file("${rootDir}/config/spotbugsFilter.xml"))
 }
 
+spotless {
+  java {
+    googleJavaFormat("1.17.0").aosp().reflowLongStrings().skipJavadocFormatting()
+  }
+}
+
 publishing {
     repositories {
         maven {

libcobj/app/src/main/java/jp/osscons/opensourcecobol/libcobj/Const.java

@@ -1,27 +1,27 @@
-/*
- * Copyright (C) 2021-2022 TOKYO SYSTEM HOUSE Co., Ltd.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 3.0,
- * or (at your option) any later version.
- *
- * This library 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 Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; see the file COPYING.LIB.  If
- * not, write to the Free Software Foundation, 51 Franklin Street, Fifth Floor
- * Boston, MA 02110-1301 USA
- */
-
-package jp.osscons.opensourcecobol.libcobj;
-
-/** TODO: 準備中 */
-public class Const {
-
-  /** TODO: 準備中 */
-  public static final String version = "1.1.2";
-}
+/*
+ * Copyright (C) 2021-2022 TOKYO SYSTEM HOUSE Co., Ltd.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 3.0,
+ * or (at your option) any later version.
+ *
+ * This library 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; see the file COPYING.LIB.  If
+ * not, write to the Free Software Foundation, 51 Franklin Street, Fifth Floor
+ * Boston, MA 02110-1301 USA
+ */
+
+package jp.osscons.opensourcecobol.libcobj;
+
+/** TODO: 準備中 */
+public class Const {
+
+    /** TODO: 準備中 */
+    public static final String version = "1.1.2";
+}