From 01d83323ada14b847e15dc2f559cfb52b37da586 Mon Sep 17 00:00:00 2001 From: Thomas Walker Lynch Date: Wed, 2 Oct 2024 15:22:01 +0000 Subject: [PATCH] resting to original naming scheme --- build.gradle | 2 + .../ANTLR/ANTLRv4Lexer.g4 | 0 .../ANTLR/ANTLRv4Parser.g4 | 0 {developers => developer}/ANTLR/Arithmetic.g4 | 0 .../ANTLR/Arithmetic2.g4 | 0 .../ANTLR/GQL_20240412.g4 | 0 .../ANTLR/GQL_20240412_rf1_literals.g4 | 0 .../ANTLR/GQL_20240412_substituted.g4 | 0 {developers => developer}/ANTLR/LexBasic.g4 | 0 .../ANTLR/LexerAdaptor.java | 0 .../ANTLR/lexer_rules.g4 | 0 {developers => developer}/build.gradle | 0 .../dependency_graph_definition.groovy | 0 .../deprecated}/.gitignore | 0 .../document}/#rule_list.txt# | 0 .../document}/.githolder | 0 .../document}/.ispell_antlr | 0 .../document}/Cypher_GQL_differences.txt | 0 .../document}/GQL_20240412_rule_list.txt | 0 .../document}/antlr-mode.el | 0 .../document}/cycle_dection.html | 0 .../document}/dependency_graph.html | 0 .../document}/deps.gradle | 0 .../readers => developer/document}/emacs.txt | 0 .../document}/for_developers.md | 0 .../document}/grammar_source.txt | 0 .../readers => developer/document}/groovy.el | 2 + .../document}/node_labels_unique_q.txt | 0 .../document}/rule_list.txt | 0 .../document}/rules_by_catebory.txt | 0 .../document}/rules_by_category.html | 0 .../document}/terminal_symbol_list.txt | 0 .../terminal_symbol_list_unsorted.txt | 0 .../executor/ANTLR_OUT_FL | 0 .../build_from_dependency_graph.groovy | 8 -- .../executor/cat_w_names | 0 {developers => developer}/executor/clean | 0 .../executor/clean_directory | 0 .../executor/clean_file_list | 0 .../executor/clean_grammar | 0 .../executor/clean_program | 0 developer/executor/env_build | 15 ++++ {developers => developer}/executor/gradle | 0 .../experiment}/.githolder | 0 .../experiment/script2.sh | 0 .../javac/ANTLR/.gitignore | 0 .../javac/leaf/ANTLR_OUT_FL.java | 0 .../javac/leaf/Arithmetic_Echo.java | 0 .../leaf/Arithmetic_Echo_PrintVisitor.java | 0 .../javac/leaf/Arithmetic_Echo__Test.java | 0 .../javac/leaf/Arithmetic_Swap.java | 0 .../javac/leaf/Arithmetic_SwapVisitor.java | 0 .../javac/leaf/Arithmetic_SyntaxAnnotate.java | 0 ...rithmetic_SyntaxAnnotate_PrintVisitor.java | 0 .../leaf/Arithmetic_SyntaxAnnotate__Test.java | 0 .../javac/leaf/RuleNameList.java | 0 .../javac/leaf/RuleNameListRegx.java | 0 .../javac/leaf/StringUtils.java | 0 .../javac/leaf/Synthesize_SyntaxAnnotate.java | 0 ...ynthesize_SyntaxAnnotate_PrintVisitor.java | 0 ...ize_SyntaxAnnotate_PrintVisitorMethod.java | 0 .../javac/leaf/TestBench.java | 0 .../javac/synthesized/.gitignore | 0 {developers => developer}/jvm/.gitignore | 0 .../tanuki => developer/temporary}/.gitignore | 0 .../Arithmetic_SyntaxAnnotate__Test_0.txt | 0 .../Arithmetic_SyntaxAnnotate__Test_1.txt | 0 .../Arithmetic_SyntaxAnnotate__Test_2.txt | 0 .../Arithmetic_SyntaxAnnotate__Test_3.txt | 0 .../Arithmetic_SyntaxAnnotate__Test_4.txt | 0 .../test/Neo4NBA/create_relationship_0.cypher | 0 .../test/Neo4NBA/create_team_0.cypher | 0 .../delete_player_and_relationship.cypher | 0 .../test/Neo4NBA/notes.txt | 0 .../Neo4NBA/query_players_by_team_0.cypher | 0 .../test/Neo4NBA/updating_nodes_0.cypher | 0 ...d_graph_from_graph_type_(double_colon).gql | 0 ...closed_graph_from_graph_type_(lexical).gql | 0 ..._from_nested_graph_type_(double_colon).gql | 0 .../create_graph.gql | 0 .../create_schema.gql | 0 .../insert_statement.gql | 0 .../match_and_insert_example.gql | 0 ...cate_(match_block_statement_in_braces).gql | 0 ...(match_block_statement_in_parentheses).gql | 0 ...sts_predicate_(nested_match_statement).gql | 0 .../session_set_graph_to_current_graph.gql | 0 ...on_set_graph_to_current_property_graph.gql | 0 .../session_set_property_as_value.gql | 0 .../session_set_time_zone.gql | 0 .../transcript_Arithmetic_Syntax__Test.sh | 0 .../test/transcript_RuleNameList.sh | 0 .../test/transcript_notes.txt | 0 .../test/transcript_test_Arithmetic_Echo.sh | 0 .../test/transcript_test_Arithmetic_Syntax.sh | 0 .../transcript_test_PrintRuleNameListRegx.sh | 0 {readers => document}/README.md | 0 document/directory_naming.txt | 82 ++++++++++++++++++ {readers => document}/log.md | 0 executor/env_dev | 18 ++-- readers/directory_naming.txt | 84 ------------------- {tanuki => temporary}/.gitignore | 0 tool/.gitignore | 8 ++ tool/upstream/.gitignore | 2 + toolsmiths/.gitignore | 4 - 105 files changed, 119 insertions(+), 106 deletions(-) rename {developers => developer}/ANTLR/ANTLRv4Lexer.g4 (100%) rename {developers => developer}/ANTLR/ANTLRv4Parser.g4 (100%) rename {developers => developer}/ANTLR/Arithmetic.g4 (100%) rename {developers => developer}/ANTLR/Arithmetic2.g4 (100%) rename {developers => developer}/ANTLR/GQL_20240412.g4 (100%) rename {developers => developer}/ANTLR/GQL_20240412_rf1_literals.g4 (100%) rename {developers => developer}/ANTLR/GQL_20240412_substituted.g4 (100%) rename {developers => developer}/ANTLR/LexBasic.g4 (100%) rename {developers => developer}/ANTLR/LexerAdaptor.java (100%) rename {developers => developer}/ANTLR/lexer_rules.g4 (100%) rename {developers => developer}/build.gradle (100%) rename {developers => developer}/dependency_graph_definition.groovy (100%) rename {developers/Somnus => developer/deprecated}/.gitignore (100%) rename {developers/readers => developer/document}/#rule_list.txt# (100%) rename {developers/experiment => developer/document}/.githolder (100%) rename {developers/readers => developer/document}/.ispell_antlr (100%) rename {developers/readers => developer/document}/Cypher_GQL_differences.txt (100%) rename {developers/readers => developer/document}/GQL_20240412_rule_list.txt (100%) rename {developers/readers => developer/document}/antlr-mode.el (100%) rename {developers/readers => developer/document}/cycle_dection.html (100%) rename {developers/readers => developer/document}/dependency_graph.html (100%) rename {developers/readers => developer/document}/deps.gradle (100%) rename {developers/readers => developer/document}/emacs.txt (100%) rename {developers/readers => developer/document}/for_developers.md (100%) rename {developers/readers => developer/document}/grammar_source.txt (100%) rename {developers/readers => developer/document}/groovy.el (77%) rename {developers/readers => developer/document}/node_labels_unique_q.txt (100%) rename {developers/readers => developer/document}/rule_list.txt (100%) rename {developers/readers => developer/document}/rules_by_catebory.txt (100%) rename {developers/readers => developer/document}/rules_by_category.html (100%) rename {developers/readers => developer/document}/terminal_symbol_list.txt (100%) rename {developers/readers => developer/document}/terminal_symbol_list_unsorted.txt (100%) rename {developers => developer}/executor/ANTLR_OUT_FL (100%) rename {developers => developer}/executor/build_from_dependency_graph.groovy (98%) rename {developers => developer}/executor/cat_w_names (100%) rename {developers => developer}/executor/clean (100%) rename {developers => developer}/executor/clean_directory (100%) rename {developers => developer}/executor/clean_file_list (100%) rename {developers => developer}/executor/clean_grammar (100%) rename {developers => developer}/executor/clean_program (100%) create mode 100755 developer/executor/env_build rename {developers => developer}/executor/gradle (100%) rename {developers/readers => developer/experiment}/.githolder (100%) rename {developers => developer}/experiment/script2.sh (100%) rename {developers => developer}/javac/ANTLR/.gitignore (100%) rename {developers => developer}/javac/leaf/ANTLR_OUT_FL.java (100%) rename {developers => developer}/javac/leaf/Arithmetic_Echo.java (100%) rename {developers => developer}/javac/leaf/Arithmetic_Echo_PrintVisitor.java (100%) rename {developers => developer}/javac/leaf/Arithmetic_Echo__Test.java (100%) rename {developers => developer}/javac/leaf/Arithmetic_Swap.java (100%) rename {developers => developer}/javac/leaf/Arithmetic_SwapVisitor.java (100%) rename {developers => developer}/javac/leaf/Arithmetic_SyntaxAnnotate.java (100%) rename {developers => developer}/javac/leaf/Arithmetic_SyntaxAnnotate_PrintVisitor.java (100%) rename {developers => developer}/javac/leaf/Arithmetic_SyntaxAnnotate__Test.java (100%) rename {developers => developer}/javac/leaf/RuleNameList.java (100%) rename {developers => developer}/javac/leaf/RuleNameListRegx.java (100%) rename {developers => developer}/javac/leaf/StringUtils.java (100%) rename {developers => developer}/javac/leaf/Synthesize_SyntaxAnnotate.java (100%) rename {developers => developer}/javac/leaf/Synthesize_SyntaxAnnotate_PrintVisitor.java (100%) rename {developers => developer}/javac/leaf/Synthesize_SyntaxAnnotate_PrintVisitorMethod.java (100%) rename {developers => developer}/javac/leaf/TestBench.java (100%) rename {developers => developer}/javac/synthesized/.gitignore (100%) rename {developers => developer}/jvm/.gitignore (100%) rename {developers/tanuki => developer/temporary}/.gitignore (100%) rename {developers => developer}/test/Arithmetic_SyntaxAnnotate__Test_0.txt (100%) rename {developers => developer}/test/Arithmetic_SyntaxAnnotate__Test_1.txt (100%) rename {developers => developer}/test/Arithmetic_SyntaxAnnotate__Test_2.txt (100%) rename {developers => developer}/test/Arithmetic_SyntaxAnnotate__Test_3.txt (100%) rename {developers => developer}/test/Arithmetic_SyntaxAnnotate__Test_4.txt (100%) rename {developers => developer}/test/Neo4NBA/create_relationship_0.cypher (100%) rename {developers => developer}/test/Neo4NBA/create_team_0.cypher (100%) rename {developers => developer}/test/Neo4NBA/delete_player_and_relationship.cypher (100%) rename {developers => developer}/test/Neo4NBA/notes.txt (100%) rename {developers => developer}/test/Neo4NBA/query_players_by_team_0.cypher (100%) rename {developers => developer}/test/Neo4NBA/updating_nodes_0.cypher (100%) rename {developers => developer}/test/opengql_grammar_samples_20240801/create_closed_graph_from_graph_type_(double_colon).gql (100%) rename {developers => developer}/test/opengql_grammar_samples_20240801/create_closed_graph_from_graph_type_(lexical).gql (100%) rename {developers => developer}/test/opengql_grammar_samples_20240801/create_closed_graph_from_nested_graph_type_(double_colon).gql (100%) rename {developers => developer}/test/opengql_grammar_samples_20240801/create_graph.gql (100%) rename {developers => developer}/test/opengql_grammar_samples_20240801/create_schema.gql (100%) rename {developers => developer}/test/opengql_grammar_samples_20240801/insert_statement.gql (100%) rename {developers => developer}/test/opengql_grammar_samples_20240801/match_and_insert_example.gql (100%) rename {developers => developer}/test/opengql_grammar_samples_20240801/match_with_exists_predicate_(match_block_statement_in_braces).gql (100%) rename {developers => developer}/test/opengql_grammar_samples_20240801/match_with_exists_predicate_(match_block_statement_in_parentheses).gql (100%) rename {developers => developer}/test/opengql_grammar_samples_20240801/match_with_exists_predicate_(nested_match_statement).gql (100%) rename {developers => developer}/test/opengql_grammar_samples_20240801/session_set_graph_to_current_graph.gql (100%) rename {developers => developer}/test/opengql_grammar_samples_20240801/session_set_graph_to_current_property_graph.gql (100%) rename {developers => developer}/test/opengql_grammar_samples_20240801/session_set_property_as_value.gql (100%) rename {developers => developer}/test/opengql_grammar_samples_20240801/session_set_time_zone.gql (100%) rename {developers => developer}/test/transcript_Arithmetic_Syntax__Test.sh (100%) rename {developers => developer}/test/transcript_RuleNameList.sh (100%) rename {developers => developer}/test/transcript_notes.txt (100%) rename {developers => developer}/test/transcript_test_Arithmetic_Echo.sh (100%) rename {developers => developer}/test/transcript_test_Arithmetic_Syntax.sh (100%) rename {developers => developer}/test/transcript_test_PrintRuleNameListRegx.sh (100%) rename {readers => document}/README.md (100%) create mode 100644 document/directory_naming.txt rename {readers => document}/log.md (100%) delete mode 100644 readers/directory_naming.txt rename {tanuki => temporary}/.gitignore (100%) create mode 100644 tool/.gitignore create mode 100644 tool/upstream/.gitignore delete mode 100644 toolsmiths/.gitignore diff --git a/build.gradle b/build.gradle index 1358aa3..eaa7628 100644 --- a/build.gradle +++ b/build.gradle @@ -83,6 +83,8 @@ task installAntlr { } } + +// rather circular no? task installJava { dependsOn preface doLast { diff --git a/developers/ANTLR/ANTLRv4Lexer.g4 b/developer/ANTLR/ANTLRv4Lexer.g4 similarity index 100% rename from developers/ANTLR/ANTLRv4Lexer.g4 rename to developer/ANTLR/ANTLRv4Lexer.g4 diff --git a/developers/ANTLR/ANTLRv4Parser.g4 b/developer/ANTLR/ANTLRv4Parser.g4 similarity index 100% rename from developers/ANTLR/ANTLRv4Parser.g4 rename to developer/ANTLR/ANTLRv4Parser.g4 diff --git a/developers/ANTLR/Arithmetic.g4 b/developer/ANTLR/Arithmetic.g4 similarity index 100% rename from developers/ANTLR/Arithmetic.g4 rename to developer/ANTLR/Arithmetic.g4 diff --git a/developers/ANTLR/Arithmetic2.g4 b/developer/ANTLR/Arithmetic2.g4 similarity index 100% rename from developers/ANTLR/Arithmetic2.g4 rename to developer/ANTLR/Arithmetic2.g4 diff --git a/developers/ANTLR/GQL_20240412.g4 b/developer/ANTLR/GQL_20240412.g4 similarity index 100% rename from developers/ANTLR/GQL_20240412.g4 rename to developer/ANTLR/GQL_20240412.g4 diff --git a/developers/ANTLR/GQL_20240412_rf1_literals.g4 b/developer/ANTLR/GQL_20240412_rf1_literals.g4 similarity index 100% rename from developers/ANTLR/GQL_20240412_rf1_literals.g4 rename to developer/ANTLR/GQL_20240412_rf1_literals.g4 diff --git a/developers/ANTLR/GQL_20240412_substituted.g4 b/developer/ANTLR/GQL_20240412_substituted.g4 similarity index 100% rename from developers/ANTLR/GQL_20240412_substituted.g4 rename to developer/ANTLR/GQL_20240412_substituted.g4 diff --git a/developers/ANTLR/LexBasic.g4 b/developer/ANTLR/LexBasic.g4 similarity index 100% rename from developers/ANTLR/LexBasic.g4 rename to developer/ANTLR/LexBasic.g4 diff --git a/developers/ANTLR/LexerAdaptor.java b/developer/ANTLR/LexerAdaptor.java similarity index 100% rename from developers/ANTLR/LexerAdaptor.java rename to developer/ANTLR/LexerAdaptor.java diff --git a/developers/ANTLR/lexer_rules.g4 b/developer/ANTLR/lexer_rules.g4 similarity index 100% rename from developers/ANTLR/lexer_rules.g4 rename to developer/ANTLR/lexer_rules.g4 diff --git a/developers/build.gradle b/developer/build.gradle similarity index 100% rename from developers/build.gradle rename to developer/build.gradle diff --git a/developers/dependency_graph_definition.groovy b/developer/dependency_graph_definition.groovy similarity index 100% rename from developers/dependency_graph_definition.groovy rename to developer/dependency_graph_definition.groovy diff --git a/developers/Somnus/.gitignore b/developer/deprecated/.gitignore similarity index 100% rename from developers/Somnus/.gitignore rename to developer/deprecated/.gitignore diff --git a/developers/readers/#rule_list.txt# b/developer/document/#rule_list.txt# similarity index 100% rename from developers/readers/#rule_list.txt# rename to developer/document/#rule_list.txt# diff --git a/developers/experiment/.githolder b/developer/document/.githolder similarity index 100% rename from developers/experiment/.githolder rename to developer/document/.githolder diff --git a/developers/readers/.ispell_antlr b/developer/document/.ispell_antlr similarity index 100% rename from developers/readers/.ispell_antlr rename to developer/document/.ispell_antlr diff --git a/developers/readers/Cypher_GQL_differences.txt b/developer/document/Cypher_GQL_differences.txt similarity index 100% rename from developers/readers/Cypher_GQL_differences.txt rename to developer/document/Cypher_GQL_differences.txt diff --git a/developers/readers/GQL_20240412_rule_list.txt b/developer/document/GQL_20240412_rule_list.txt similarity index 100% rename from developers/readers/GQL_20240412_rule_list.txt rename to developer/document/GQL_20240412_rule_list.txt diff --git a/developers/readers/antlr-mode.el b/developer/document/antlr-mode.el similarity index 100% rename from developers/readers/antlr-mode.el rename to developer/document/antlr-mode.el diff --git a/developers/readers/cycle_dection.html b/developer/document/cycle_dection.html similarity index 100% rename from developers/readers/cycle_dection.html rename to developer/document/cycle_dection.html diff --git a/developers/readers/dependency_graph.html b/developer/document/dependency_graph.html similarity index 100% rename from developers/readers/dependency_graph.html rename to developer/document/dependency_graph.html diff --git a/developers/readers/deps.gradle b/developer/document/deps.gradle similarity index 100% rename from developers/readers/deps.gradle rename to developer/document/deps.gradle diff --git a/developers/readers/emacs.txt b/developer/document/emacs.txt similarity index 100% rename from developers/readers/emacs.txt rename to developer/document/emacs.txt diff --git a/developers/readers/for_developers.md b/developer/document/for_developers.md similarity index 100% rename from developers/readers/for_developers.md rename to developer/document/for_developers.md diff --git a/developers/readers/grammar_source.txt b/developer/document/grammar_source.txt similarity index 100% rename from developers/readers/grammar_source.txt rename to developer/document/grammar_source.txt diff --git a/developers/readers/groovy.el b/developer/document/groovy.el similarity index 77% rename from developers/readers/groovy.el rename to developer/document/groovy.el index f08befb..1a93312 100644 --- a/developers/readers/groovy.el +++ b/developer/document/groovy.el @@ -15,3 +15,5 @@ (setq groovy-indent-offset 2) ) +;; Enable Groovy mode for files with `#!/usr/bin/env groovy` shebang +(add-to-list 'interpreter-mode-alist '("groovy" . groovy-mode)) diff --git a/developers/readers/node_labels_unique_q.txt b/developer/document/node_labels_unique_q.txt similarity index 100% rename from developers/readers/node_labels_unique_q.txt rename to developer/document/node_labels_unique_q.txt diff --git a/developers/readers/rule_list.txt b/developer/document/rule_list.txt similarity index 100% rename from developers/readers/rule_list.txt rename to developer/document/rule_list.txt diff --git a/developers/readers/rules_by_catebory.txt b/developer/document/rules_by_catebory.txt similarity index 100% rename from developers/readers/rules_by_catebory.txt rename to developer/document/rules_by_catebory.txt diff --git a/developers/readers/rules_by_category.html b/developer/document/rules_by_category.html similarity index 100% rename from developers/readers/rules_by_category.html rename to developer/document/rules_by_category.html diff --git a/developers/readers/terminal_symbol_list.txt b/developer/document/terminal_symbol_list.txt similarity index 100% rename from developers/readers/terminal_symbol_list.txt rename to developer/document/terminal_symbol_list.txt diff --git a/developers/readers/terminal_symbol_list_unsorted.txt b/developer/document/terminal_symbol_list_unsorted.txt similarity index 100% rename from developers/readers/terminal_symbol_list_unsorted.txt rename to developer/document/terminal_symbol_list_unsorted.txt diff --git a/developers/executor/ANTLR_OUT_FL b/developer/executor/ANTLR_OUT_FL similarity index 100% rename from developers/executor/ANTLR_OUT_FL rename to developer/executor/ANTLR_OUT_FL diff --git a/developers/executor/build_from_dependency_graph.groovy b/developer/executor/build_from_dependency_graph.groovy similarity index 98% rename from developers/executor/build_from_dependency_graph.groovy rename to developer/executor/build_from_dependency_graph.groovy index 5023600..11a4900 100644 --- a/developers/executor/build_from_dependency_graph.groovy +++ b/developer/executor/build_from_dependency_graph.groovy @@ -594,11 +594,3 @@ def clean_nodes(root_node_labels ,boolean verbose = true){ } -// LocalWords: FN FPL DN DNL RuleNameListRegx RuleNameList PrintVisitorMethod -// LocalWords: PrintVisitor SyntaxAnnotate wellformed defacto acyclic -g - - - - -// LocalWords: wellformed unvisited diff --git a/developers/executor/cat_w_names b/developer/executor/cat_w_names similarity index 100% rename from developers/executor/cat_w_names rename to developer/executor/cat_w_names diff --git a/developers/executor/clean b/developer/executor/clean similarity index 100% rename from developers/executor/clean rename to developer/executor/clean diff --git a/developers/executor/clean_directory b/developer/executor/clean_directory similarity index 100% rename from developers/executor/clean_directory rename to developer/executor/clean_directory diff --git a/developers/executor/clean_file_list b/developer/executor/clean_file_list similarity index 100% rename from developers/executor/clean_file_list rename to developer/executor/clean_file_list diff --git a/developers/executor/clean_grammar b/developer/executor/clean_grammar similarity index 100% rename from developers/executor/clean_grammar rename to developer/executor/clean_grammar diff --git a/developers/executor/clean_program b/developer/executor/clean_program similarity index 100% rename from developers/executor/clean_program rename to developer/executor/clean_program diff --git a/developer/executor/env_build b/developer/executor/env_build new file mode 100755 index 0000000..4d64d43 --- /dev/null +++ b/developer/executor/env_build @@ -0,0 +1,15 @@ +#!/usr/bin/env bash + +# The build environment. +# +# Most of this has been moved into the Ariande build script. + +# Ensure the script is sourced rather than run directly +if [[ "${BASH_SOURCE[0]}" == "$0" ]]; then + echo "This script must be sourced, not executed. Exiting." + return 1 +fi +export ENV_BUILD_VERSION="0.3" + + +# LocalWords: Ariande diff --git a/developers/executor/gradle b/developer/executor/gradle similarity index 100% rename from developers/executor/gradle rename to developer/executor/gradle diff --git a/developers/readers/.githolder b/developer/experiment/.githolder similarity index 100% rename from developers/readers/.githolder rename to developer/experiment/.githolder diff --git a/developers/experiment/script2.sh b/developer/experiment/script2.sh similarity index 100% rename from developers/experiment/script2.sh rename to developer/experiment/script2.sh diff --git a/developers/javac/ANTLR/.gitignore b/developer/javac/ANTLR/.gitignore similarity index 100% rename from developers/javac/ANTLR/.gitignore rename to developer/javac/ANTLR/.gitignore diff --git a/developers/javac/leaf/ANTLR_OUT_FL.java b/developer/javac/leaf/ANTLR_OUT_FL.java similarity index 100% rename from developers/javac/leaf/ANTLR_OUT_FL.java rename to developer/javac/leaf/ANTLR_OUT_FL.java diff --git a/developers/javac/leaf/Arithmetic_Echo.java b/developer/javac/leaf/Arithmetic_Echo.java similarity index 100% rename from developers/javac/leaf/Arithmetic_Echo.java rename to developer/javac/leaf/Arithmetic_Echo.java diff --git a/developers/javac/leaf/Arithmetic_Echo_PrintVisitor.java b/developer/javac/leaf/Arithmetic_Echo_PrintVisitor.java similarity index 100% rename from developers/javac/leaf/Arithmetic_Echo_PrintVisitor.java rename to developer/javac/leaf/Arithmetic_Echo_PrintVisitor.java diff --git a/developers/javac/leaf/Arithmetic_Echo__Test.java b/developer/javac/leaf/Arithmetic_Echo__Test.java similarity index 100% rename from developers/javac/leaf/Arithmetic_Echo__Test.java rename to developer/javac/leaf/Arithmetic_Echo__Test.java diff --git a/developers/javac/leaf/Arithmetic_Swap.java b/developer/javac/leaf/Arithmetic_Swap.java similarity index 100% rename from developers/javac/leaf/Arithmetic_Swap.java rename to developer/javac/leaf/Arithmetic_Swap.java diff --git a/developers/javac/leaf/Arithmetic_SwapVisitor.java b/developer/javac/leaf/Arithmetic_SwapVisitor.java similarity index 100% rename from developers/javac/leaf/Arithmetic_SwapVisitor.java rename to developer/javac/leaf/Arithmetic_SwapVisitor.java diff --git a/developers/javac/leaf/Arithmetic_SyntaxAnnotate.java b/developer/javac/leaf/Arithmetic_SyntaxAnnotate.java similarity index 100% rename from developers/javac/leaf/Arithmetic_SyntaxAnnotate.java rename to developer/javac/leaf/Arithmetic_SyntaxAnnotate.java diff --git a/developers/javac/leaf/Arithmetic_SyntaxAnnotate_PrintVisitor.java b/developer/javac/leaf/Arithmetic_SyntaxAnnotate_PrintVisitor.java similarity index 100% rename from developers/javac/leaf/Arithmetic_SyntaxAnnotate_PrintVisitor.java rename to developer/javac/leaf/Arithmetic_SyntaxAnnotate_PrintVisitor.java diff --git a/developers/javac/leaf/Arithmetic_SyntaxAnnotate__Test.java b/developer/javac/leaf/Arithmetic_SyntaxAnnotate__Test.java similarity index 100% rename from developers/javac/leaf/Arithmetic_SyntaxAnnotate__Test.java rename to developer/javac/leaf/Arithmetic_SyntaxAnnotate__Test.java diff --git a/developers/javac/leaf/RuleNameList.java b/developer/javac/leaf/RuleNameList.java similarity index 100% rename from developers/javac/leaf/RuleNameList.java rename to developer/javac/leaf/RuleNameList.java diff --git a/developers/javac/leaf/RuleNameListRegx.java b/developer/javac/leaf/RuleNameListRegx.java similarity index 100% rename from developers/javac/leaf/RuleNameListRegx.java rename to developer/javac/leaf/RuleNameListRegx.java diff --git a/developers/javac/leaf/StringUtils.java b/developer/javac/leaf/StringUtils.java similarity index 100% rename from developers/javac/leaf/StringUtils.java rename to developer/javac/leaf/StringUtils.java diff --git a/developers/javac/leaf/Synthesize_SyntaxAnnotate.java b/developer/javac/leaf/Synthesize_SyntaxAnnotate.java similarity index 100% rename from developers/javac/leaf/Synthesize_SyntaxAnnotate.java rename to developer/javac/leaf/Synthesize_SyntaxAnnotate.java diff --git a/developers/javac/leaf/Synthesize_SyntaxAnnotate_PrintVisitor.java b/developer/javac/leaf/Synthesize_SyntaxAnnotate_PrintVisitor.java similarity index 100% rename from developers/javac/leaf/Synthesize_SyntaxAnnotate_PrintVisitor.java rename to developer/javac/leaf/Synthesize_SyntaxAnnotate_PrintVisitor.java diff --git a/developers/javac/leaf/Synthesize_SyntaxAnnotate_PrintVisitorMethod.java b/developer/javac/leaf/Synthesize_SyntaxAnnotate_PrintVisitorMethod.java similarity index 100% rename from developers/javac/leaf/Synthesize_SyntaxAnnotate_PrintVisitorMethod.java rename to developer/javac/leaf/Synthesize_SyntaxAnnotate_PrintVisitorMethod.java diff --git a/developers/javac/leaf/TestBench.java b/developer/javac/leaf/TestBench.java similarity index 100% rename from developers/javac/leaf/TestBench.java rename to developer/javac/leaf/TestBench.java diff --git a/developers/javac/synthesized/.gitignore b/developer/javac/synthesized/.gitignore similarity index 100% rename from developers/javac/synthesized/.gitignore rename to developer/javac/synthesized/.gitignore diff --git a/developers/jvm/.gitignore b/developer/jvm/.gitignore similarity index 100% rename from developers/jvm/.gitignore rename to developer/jvm/.gitignore diff --git a/developers/tanuki/.gitignore b/developer/temporary/.gitignore similarity index 100% rename from developers/tanuki/.gitignore rename to developer/temporary/.gitignore diff --git a/developers/test/Arithmetic_SyntaxAnnotate__Test_0.txt b/developer/test/Arithmetic_SyntaxAnnotate__Test_0.txt similarity index 100% rename from developers/test/Arithmetic_SyntaxAnnotate__Test_0.txt rename to developer/test/Arithmetic_SyntaxAnnotate__Test_0.txt diff --git a/developers/test/Arithmetic_SyntaxAnnotate__Test_1.txt b/developer/test/Arithmetic_SyntaxAnnotate__Test_1.txt similarity index 100% rename from developers/test/Arithmetic_SyntaxAnnotate__Test_1.txt rename to developer/test/Arithmetic_SyntaxAnnotate__Test_1.txt diff --git a/developers/test/Arithmetic_SyntaxAnnotate__Test_2.txt b/developer/test/Arithmetic_SyntaxAnnotate__Test_2.txt similarity index 100% rename from developers/test/Arithmetic_SyntaxAnnotate__Test_2.txt rename to developer/test/Arithmetic_SyntaxAnnotate__Test_2.txt diff --git a/developers/test/Arithmetic_SyntaxAnnotate__Test_3.txt b/developer/test/Arithmetic_SyntaxAnnotate__Test_3.txt similarity index 100% rename from developers/test/Arithmetic_SyntaxAnnotate__Test_3.txt rename to developer/test/Arithmetic_SyntaxAnnotate__Test_3.txt diff --git a/developers/test/Arithmetic_SyntaxAnnotate__Test_4.txt b/developer/test/Arithmetic_SyntaxAnnotate__Test_4.txt similarity index 100% rename from developers/test/Arithmetic_SyntaxAnnotate__Test_4.txt rename to developer/test/Arithmetic_SyntaxAnnotate__Test_4.txt diff --git a/developers/test/Neo4NBA/create_relationship_0.cypher b/developer/test/Neo4NBA/create_relationship_0.cypher similarity index 100% rename from developers/test/Neo4NBA/create_relationship_0.cypher rename to developer/test/Neo4NBA/create_relationship_0.cypher diff --git a/developers/test/Neo4NBA/create_team_0.cypher b/developer/test/Neo4NBA/create_team_0.cypher similarity index 100% rename from developers/test/Neo4NBA/create_team_0.cypher rename to developer/test/Neo4NBA/create_team_0.cypher diff --git a/developers/test/Neo4NBA/delete_player_and_relationship.cypher b/developer/test/Neo4NBA/delete_player_and_relationship.cypher similarity index 100% rename from developers/test/Neo4NBA/delete_player_and_relationship.cypher rename to developer/test/Neo4NBA/delete_player_and_relationship.cypher diff --git a/developers/test/Neo4NBA/notes.txt b/developer/test/Neo4NBA/notes.txt similarity index 100% rename from developers/test/Neo4NBA/notes.txt rename to developer/test/Neo4NBA/notes.txt diff --git a/developers/test/Neo4NBA/query_players_by_team_0.cypher b/developer/test/Neo4NBA/query_players_by_team_0.cypher similarity index 100% rename from developers/test/Neo4NBA/query_players_by_team_0.cypher rename to developer/test/Neo4NBA/query_players_by_team_0.cypher diff --git a/developers/test/Neo4NBA/updating_nodes_0.cypher b/developer/test/Neo4NBA/updating_nodes_0.cypher similarity index 100% rename from developers/test/Neo4NBA/updating_nodes_0.cypher rename to developer/test/Neo4NBA/updating_nodes_0.cypher diff --git a/developers/test/opengql_grammar_samples_20240801/create_closed_graph_from_graph_type_(double_colon).gql b/developer/test/opengql_grammar_samples_20240801/create_closed_graph_from_graph_type_(double_colon).gql similarity index 100% rename from developers/test/opengql_grammar_samples_20240801/create_closed_graph_from_graph_type_(double_colon).gql rename to developer/test/opengql_grammar_samples_20240801/create_closed_graph_from_graph_type_(double_colon).gql diff --git a/developers/test/opengql_grammar_samples_20240801/create_closed_graph_from_graph_type_(lexical).gql b/developer/test/opengql_grammar_samples_20240801/create_closed_graph_from_graph_type_(lexical).gql similarity index 100% rename from developers/test/opengql_grammar_samples_20240801/create_closed_graph_from_graph_type_(lexical).gql rename to developer/test/opengql_grammar_samples_20240801/create_closed_graph_from_graph_type_(lexical).gql diff --git a/developers/test/opengql_grammar_samples_20240801/create_closed_graph_from_nested_graph_type_(double_colon).gql b/developer/test/opengql_grammar_samples_20240801/create_closed_graph_from_nested_graph_type_(double_colon).gql similarity index 100% rename from developers/test/opengql_grammar_samples_20240801/create_closed_graph_from_nested_graph_type_(double_colon).gql rename to developer/test/opengql_grammar_samples_20240801/create_closed_graph_from_nested_graph_type_(double_colon).gql diff --git a/developers/test/opengql_grammar_samples_20240801/create_graph.gql b/developer/test/opengql_grammar_samples_20240801/create_graph.gql similarity index 100% rename from developers/test/opengql_grammar_samples_20240801/create_graph.gql rename to developer/test/opengql_grammar_samples_20240801/create_graph.gql diff --git a/developers/test/opengql_grammar_samples_20240801/create_schema.gql b/developer/test/opengql_grammar_samples_20240801/create_schema.gql similarity index 100% rename from developers/test/opengql_grammar_samples_20240801/create_schema.gql rename to developer/test/opengql_grammar_samples_20240801/create_schema.gql diff --git a/developers/test/opengql_grammar_samples_20240801/insert_statement.gql b/developer/test/opengql_grammar_samples_20240801/insert_statement.gql similarity index 100% rename from developers/test/opengql_grammar_samples_20240801/insert_statement.gql rename to developer/test/opengql_grammar_samples_20240801/insert_statement.gql diff --git a/developers/test/opengql_grammar_samples_20240801/match_and_insert_example.gql b/developer/test/opengql_grammar_samples_20240801/match_and_insert_example.gql similarity index 100% rename from developers/test/opengql_grammar_samples_20240801/match_and_insert_example.gql rename to developer/test/opengql_grammar_samples_20240801/match_and_insert_example.gql diff --git a/developers/test/opengql_grammar_samples_20240801/match_with_exists_predicate_(match_block_statement_in_braces).gql b/developer/test/opengql_grammar_samples_20240801/match_with_exists_predicate_(match_block_statement_in_braces).gql similarity index 100% rename from developers/test/opengql_grammar_samples_20240801/match_with_exists_predicate_(match_block_statement_in_braces).gql rename to developer/test/opengql_grammar_samples_20240801/match_with_exists_predicate_(match_block_statement_in_braces).gql diff --git a/developers/test/opengql_grammar_samples_20240801/match_with_exists_predicate_(match_block_statement_in_parentheses).gql b/developer/test/opengql_grammar_samples_20240801/match_with_exists_predicate_(match_block_statement_in_parentheses).gql similarity index 100% rename from developers/test/opengql_grammar_samples_20240801/match_with_exists_predicate_(match_block_statement_in_parentheses).gql rename to developer/test/opengql_grammar_samples_20240801/match_with_exists_predicate_(match_block_statement_in_parentheses).gql diff --git a/developers/test/opengql_grammar_samples_20240801/match_with_exists_predicate_(nested_match_statement).gql b/developer/test/opengql_grammar_samples_20240801/match_with_exists_predicate_(nested_match_statement).gql similarity index 100% rename from developers/test/opengql_grammar_samples_20240801/match_with_exists_predicate_(nested_match_statement).gql rename to developer/test/opengql_grammar_samples_20240801/match_with_exists_predicate_(nested_match_statement).gql diff --git a/developers/test/opengql_grammar_samples_20240801/session_set_graph_to_current_graph.gql b/developer/test/opengql_grammar_samples_20240801/session_set_graph_to_current_graph.gql similarity index 100% rename from developers/test/opengql_grammar_samples_20240801/session_set_graph_to_current_graph.gql rename to developer/test/opengql_grammar_samples_20240801/session_set_graph_to_current_graph.gql diff --git a/developers/test/opengql_grammar_samples_20240801/session_set_graph_to_current_property_graph.gql b/developer/test/opengql_grammar_samples_20240801/session_set_graph_to_current_property_graph.gql similarity index 100% rename from developers/test/opengql_grammar_samples_20240801/session_set_graph_to_current_property_graph.gql rename to developer/test/opengql_grammar_samples_20240801/session_set_graph_to_current_property_graph.gql diff --git a/developers/test/opengql_grammar_samples_20240801/session_set_property_as_value.gql b/developer/test/opengql_grammar_samples_20240801/session_set_property_as_value.gql similarity index 100% rename from developers/test/opengql_grammar_samples_20240801/session_set_property_as_value.gql rename to developer/test/opengql_grammar_samples_20240801/session_set_property_as_value.gql diff --git a/developers/test/opengql_grammar_samples_20240801/session_set_time_zone.gql b/developer/test/opengql_grammar_samples_20240801/session_set_time_zone.gql similarity index 100% rename from developers/test/opengql_grammar_samples_20240801/session_set_time_zone.gql rename to developer/test/opengql_grammar_samples_20240801/session_set_time_zone.gql diff --git a/developers/test/transcript_Arithmetic_Syntax__Test.sh b/developer/test/transcript_Arithmetic_Syntax__Test.sh similarity index 100% rename from developers/test/transcript_Arithmetic_Syntax__Test.sh rename to developer/test/transcript_Arithmetic_Syntax__Test.sh diff --git a/developers/test/transcript_RuleNameList.sh b/developer/test/transcript_RuleNameList.sh similarity index 100% rename from developers/test/transcript_RuleNameList.sh rename to developer/test/transcript_RuleNameList.sh diff --git a/developers/test/transcript_notes.txt b/developer/test/transcript_notes.txt similarity index 100% rename from developers/test/transcript_notes.txt rename to developer/test/transcript_notes.txt diff --git a/developers/test/transcript_test_Arithmetic_Echo.sh b/developer/test/transcript_test_Arithmetic_Echo.sh similarity index 100% rename from developers/test/transcript_test_Arithmetic_Echo.sh rename to developer/test/transcript_test_Arithmetic_Echo.sh diff --git a/developers/test/transcript_test_Arithmetic_Syntax.sh b/developer/test/transcript_test_Arithmetic_Syntax.sh similarity index 100% rename from developers/test/transcript_test_Arithmetic_Syntax.sh rename to developer/test/transcript_test_Arithmetic_Syntax.sh diff --git a/developers/test/transcript_test_PrintRuleNameListRegx.sh b/developer/test/transcript_test_PrintRuleNameListRegx.sh similarity index 100% rename from developers/test/transcript_test_PrintRuleNameListRegx.sh rename to developer/test/transcript_test_PrintRuleNameListRegx.sh diff --git a/readers/README.md b/document/README.md similarity index 100% rename from readers/README.md rename to document/README.md diff --git a/document/directory_naming.txt b/document/directory_naming.txt new file mode 100644 index 0000000..aca6100 --- /dev/null +++ b/document/directory_naming.txt @@ -0,0 +1,82 @@ + +Naming Conventions for Directories + + Our shop has a convention of naming directories after the role of the person, + the name of the program, or generally, the agent, who is going to use the + files in the directory. In short, the name is often the answer to the question + "who are the files are for?". + + Sometimes there is not a good answer to that question. A good example is the + documents directory. There really isn't a good term for the role that people + are playing when the read the documents. Perhaps, 'readers'? This is not a + job function, and it is a somewhat ambiguous. Perhaps, 'projectologist'? Ah + nah .. + + When we can not answer the question of who the files are for, we instead + choose another common property shared by each and every file in the directory. + It is often the case that a property that each and every file has in common + will be singular. Hence in the example in the prior paragraph, when each file + in a directory has the property of being a document, the directory gets called + 'document'. + +Top Level Directory + + The top level of a github project is of course named after the project. Though + we people like to see actors related to project names. Look at all the + mythical animals on the covers of the O'Reilley manuals. + + The top level directory of our git project is reserved for project manager to + use. The project manager builds the directory structure, initializes the + repository, installs tools that will be needed, and generally administers + the project. + + In the environment, the top level directory is located at `$REPO_HOME` + +Developer + + The developer's directory is located at `$REPO_HOME/developer`. + + This directory contains the developer's workspace. Developers are free to + organize it in any manner they see fit, though they should continue to follow the + convention of naming directories after the agents that operate on the contained files. + + As examples, + + - Files for the **C compiler** are placed in the `cc` directory, since they + are "for" the C compiler. + + - Files for the **Java compiler** (javac) are stored in the `javac` directory. + + - Similar naming conventions are followed for other tools. For instance, if + the project involves files for another tool or compiler, the directory is + named after that tool. + +Executor + + Sometimes multiple related actors operate on the files in a directory. In + which case we give the directory a more general name that describes the + actors as a group. + + So if we had a directory that held a mix of files for various compilers we might + name the directory 'compiler_input' or even 'compiler'. + + One common generalization is 'executor'. An executor is any program that runs + another program; examples include shells that interpret shell scripts; + various language interpreter; and most famously the machine loader, which will + load an instruction sequence into memory and point the program counter at it. + +Temporary + + This is a scratch pad directory used by programs. Files will appear + and disappear from here. There is no reason a developer can not manually + add a file, but scripts such as `make clean`, might delete it. Directories + with this name should be git ignored. + +Deprecated + + As a developer I often have files that I set aside just in case I want to look + at them again. Sometimes I plan to bring them back later. Unlike temporary files, + they are not deleted by any clean script or any program that is using them as + intermediate files. This directory is also git ignored. + +LocalWords: projectologist diff --git a/readers/log.md b/document/log.md similarity index 100% rename from readers/log.md rename to document/log.md diff --git a/executor/env_dev b/executor/env_dev index 2bf6470..cdba4d0 100644 --- a/executor/env_dev +++ b/executor/env_dev @@ -12,20 +12,18 @@ if [ -z "$REPO_HOME" ]; then source "${script_path}/env_base" fi -export DEVELOPER_HOME="$REPO_HOME/developers" -export GRADLE_HOME="$REPO_HOME/toolsmiths/gradle-8.10-rc-1" +export JAVA_HOME="$REPO_HOME/tool/jdk-11" +export GRADLE_HOME="$REPO_HOME/tool/gradle-8.10-rc-1" export PATH=\ -"$DEVELOPER_HOME"/executor\ -:"$REPO_HOME"/toolsmiths/executor\ -:"$GRADLE_HOME"/bin\ +"$REPO_HOME"/developer/executor\ +:"$REPO_HOME"/tool/executor\ +:"$JAVA_HOME"/bin\ +:"$GROOVY_HOME"/bin\ :"$PATH" -cd "$DEVELOPER_HOME" - -# This is helpful so that cut and paste from the makefile to the shell can be used for testing. -# When making use of this, the developer must resource env_build into the shell after modifications. -source "$DEVELOPER_HOME"/executor/env_build +cd "$REPO_HOME/developer" +source executor/env_build echo "${BASH_SOURCE[0]}" "complete" diff --git a/readers/directory_naming.txt b/readers/directory_naming.txt deleted file mode 100644 index 2de57e2..0000000 --- a/readers/directory_naming.txt +++ /dev/null @@ -1,84 +0,0 @@ - -Naming Conventions for Directories - - Our shop has a convention of naming directories after the role of the person, - the name of the program, or generally, the agent, that is going to use - the files in the directory. In short, "directories are named after the agent the - files are for." - - This convention makes it easier for people to make sense of directory names. It - is also natural for people to think in terms of the actors doing things. Indeed - our ancestors saw the hand of a person, spirit, or God behind everything. - -Top Level Directory - - Sometimes this naming convention is not practical. The top level of a github - project must be named after the project. Though note here to the human - tendency to see actors. Look at all the mythical animals on the covers of the - O'Reilley manuals. - - The top level directory of our git project is reserved for project manager to - use. It will have files such as `.git`, and various scripts for maintaining - the project. The project manager will install the tools used in a directory - called 'toolsmiths. There is a sub directory for the developers, called - 'developers'. - - The top level directory is located at `$REPO_HOME` - -Developers - - The developer’s directory is located at `$REPO_HOME/developers`, and is - known in the environment as `$DEVELOPERS_HOME`. - - This directory contains the developers' workspace. Developers are free to - organize it in any manner they see fit, though they should continue to follow the - convention of naming directories after the agents that operate on the contained files. - - As examples, - - - Files for the **C compiler** are placed in the `cc` directory, since they - are "for" the C compiler. - - - Files for the **Java compiler** (javac) are stored in the `javac` directory. - - - Similar naming conventions are followed for other tools. For instance, if - the project involves files for another tool or compiler, the directory is - named after that tool. - -Executor - - Sometimes multiple actors operate on the files in a directory. In which case - we give the directory a more general name that describes the actors. - - So if we had a directory that held a mix of files for various compilers we might - name the directory 'compiler_input' or even 'compiler'. - - One common generalization is 'executor'. An executor is any program that runs - another program; examples include shells that interpret shell scripts; - various language interpreter; and most famously the machine loader, which will - load an instruction sequence into memory and point the program counter at it. - -Readers - - This refers to humans or AIs. It is short for 'Dear Readers,". These - files are for those rare individuals who read documents. - -Files for mythological beings - - I've had a bit of fun and introduced a couple of these. We wouldn't want too - many. - - tanuki, たぬき - - Both a mythical beast, and a real animal. A kind of raccoon, which like all - raccoons, will steal things, especially food. Files left within reach of a - tanuki, are likely to disappear without notice. Typically these are things - such as intermediate files during a build. - - Somnus - - As a developer I often have files that I set aside just in case I want to look - at them again. Sometimes I plan to bring them back later. Unlike tanuki files, - they are not deleted by any clean script or any program that is using them as - intermediate files. However, they do not appear it the repo. Somnus is the - Roman god of sleep. diff --git a/tanuki/.gitignore b/temporary/.gitignore similarity index 100% rename from tanuki/.gitignore rename to temporary/.gitignore diff --git a/tool/.gitignore b/tool/.gitignore new file mode 100644 index 0000000..3cdc3e0 --- /dev/null +++ b/tool/.gitignore @@ -0,0 +1,8 @@ + +* +!/.gitignore +!/document +# upstream has a .gitignore file in it +!/upstream + + diff --git a/tool/upstream/.gitignore b/tool/upstream/.gitignore new file mode 100644 index 0000000..120f485 --- /dev/null +++ b/tool/upstream/.gitignore @@ -0,0 +1,2 @@ +* +!/.gitignore diff --git a/toolsmiths/.gitignore b/toolsmiths/.gitignore deleted file mode 100644 index 2db43ed..0000000 --- a/toolsmiths/.gitignore +++ /dev/null @@ -1,4 +0,0 @@ - -* -!/.gitignore - -- 2.20.1