diff --git a/.editorconfig b/.editorconfig index 6399c11..16aea85 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,178 +1,49 @@ root = true [*] -charset = utf-8 -end_of_line = CRLF +end_of_line = crlf +insert_final_newline = true indent_style = space indent_size = 4 -insert_final_newline = false -trim_trailing_whitespace = true - -[*.sln] -indent_style = tab - -[*.{csproj,vbproj,vcxproj,vcxproj.filters}] -indent_size = 2 - -[*.{xml,config,props,targets,nuspec,ruleset}] -indent_size = 2 - -[*.{yml,yaml}] -indent_size = 2 +file_header_template = \nTerminaux.TermInfo Copyright (C) 2023-2024 Aptivi\n\nThis file is part of Terminaux.TermInfo\n\nTerminaux.TermInfo is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nTerminaux.TermInfo is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY, without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program. If not, see .\n -[*.json] -indent_size = 2 +# IDE0060: Remove unused parameter +dotnet_diagnostic.IDE0060.severity = warning +dotnet_diagnostic.CA1822.severity = none +dotnet_diagnostic.SA1120.severity = none [*.md] -trim_trailing_whitespace = false +charset = utf-8 [*.sh] end_of_line = lf -[*.cs] -# Sort using and Import directives with System.* appearing first -dotnet_sort_system_directives_first = true -dotnet_separate_import_directive_groups = false - -# Avoid "this." and "Me." if not necessary -dotnet_style_qualification_for_field = false:refactoring -dotnet_style_qualification_for_property = false:refactoring -dotnet_style_qualification_for_method = false:refactoring -dotnet_style_qualification_for_event = false:refactoring - -# Use language keywords instead of framework type names for type references -dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion -dotnet_style_predefined_type_for_member_access = true:suggestion - -# Suggest more modern language features when available -dotnet_style_object_initializer = true:suggestion -dotnet_style_collection_initializer = true:suggestion -dotnet_style_coalesce_expression = true:suggestion -dotnet_style_null_propagation = true:suggestion -dotnet_style_explicit_tuple_names = true:suggestion - -# Non-private static fields are PascalCase -dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.severity = suggestion -dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.symbols = non_private_static_fields -dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.style = non_private_static_field_style -dotnet_naming_symbols.non_private_static_fields.applicable_kinds = field -dotnet_naming_symbols.non_private_static_fields.applicable_accessibilities = public, protected, internal, protected_internal, private_protected -dotnet_naming_symbols.non_private_static_fields.required_modifiers = static -dotnet_naming_style.non_private_static_field_style.capitalization = pascal_case - -# Non-private readonly fields are PascalCase -dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.severity = suggestion -dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.symbols = non_private_readonly_fields -dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.style = non_private_readonly_field_style -dotnet_naming_symbols.non_private_readonly_fields.applicable_kinds = field -dotnet_naming_symbols.non_private_readonly_fields.applicable_accessibilities = public, protected, internal, protected_internal, private_protected -dotnet_naming_symbols.non_private_readonly_fields.required_modifiers = readonly -dotnet_naming_style.non_private_readonly_field_style.capitalization = pascal_case - -# Constants are PascalCase -dotnet_naming_rule.constants_should_be_pascal_case.severity = suggestion -dotnet_naming_rule.constants_should_be_pascal_case.symbols = constants -dotnet_naming_rule.constants_should_be_pascal_case.style = constant_style -dotnet_naming_symbols.constants.applicable_kinds = field, local -dotnet_naming_symbols.constants.required_modifiers = const -dotnet_naming_style.constant_style.capitalization = pascal_case - -# Instance fields are camelCase and start with _ -dotnet_naming_rule.instance_fields_should_be_camel_case.severity = suggestion -dotnet_naming_rule.instance_fields_should_be_camel_case.symbols = instance_fields -dotnet_naming_rule.instance_fields_should_be_camel_case.style = instance_field_style -dotnet_naming_symbols.instance_fields.applicable_kinds = field -dotnet_naming_style.instance_field_style.capitalization = camel_case -dotnet_naming_style.instance_field_style.required_prefix = _ - -# Locals and parameters are camelCase -dotnet_naming_rule.locals_should_be_camel_case.severity = suggestion -dotnet_naming_rule.locals_should_be_camel_case.symbols = locals_and_parameters -dotnet_naming_rule.locals_should_be_camel_case.style = camel_case_style -dotnet_naming_symbols.locals_and_parameters.applicable_kinds = parameter, local -dotnet_naming_style.camel_case_style.capitalization = camel_case - -# Local functions are PascalCase -dotnet_naming_rule.local_functions_should_be_pascal_case.severity = suggestion -dotnet_naming_rule.local_functions_should_be_pascal_case.symbols = local_functions -dotnet_naming_rule.local_functions_should_be_pascal_case.style = local_function_style -dotnet_naming_symbols.local_functions.applicable_kinds = local_function -dotnet_naming_style.local_function_style.capitalization = pascal_case - -# By default, name items with PascalCase -dotnet_naming_rule.members_should_be_pascal_case.severity = suggestion -dotnet_naming_rule.members_should_be_pascal_case.symbols = all_members -dotnet_naming_rule.members_should_be_pascal_case.style = pascal_case_style -dotnet_naming_symbols.all_members.applicable_kinds = * -dotnet_naming_style.pascal_case_style.capitalization = pascal_case - -# Newline settings -csharp_new_line_before_open_brace = all -csharp_new_line_before_else = true -csharp_new_line_before_catch = true -csharp_new_line_before_finally = true -csharp_new_line_before_members_in_object_initializers = true -csharp_new_line_before_members_in_anonymous_types = true -csharp_new_line_between_query_expression_clauses = true - -# Indentation preferences -csharp_indent_block_contents = true -csharp_indent_braces = false -csharp_indent_case_contents = true -csharp_indent_case_contents_when_block = true -csharp_indent_switch_labels = true -csharp_indent_labels = flush_left - -# Prefer "var" everywhere -csharp_style_var_for_built_in_types = true:suggestion -csharp_style_var_when_type_is_apparent = true:suggestion -csharp_style_var_elsewhere = true:suggestion - -# Prefer method-like constructs to have a block body -csharp_style_expression_bodied_methods = false:none -csharp_style_expression_bodied_constructors = false:none -csharp_style_expression_bodied_operators = false:none - -# Prefer property-like constructs to have an expression-body -csharp_style_expression_bodied_properties = true:none -csharp_style_expression_bodied_indexers = true:none -csharp_style_expression_bodied_accessors = true:none +[*.resx] +end_of_line = crlf +insert_final_newline = true +indent_style = space +indent_size = 2 -# Suggest more modern language features when available -csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion -csharp_style_pattern_matching_over_as_with_null_check = true:suggestion -csharp_style_inlined_variable_declaration = true:suggestion -csharp_style_throw_expression = true:suggestion -csharp_style_conditional_delegate_call = true:suggestion +[*.csproj] +end_of_line = crlf +insert_final_newline = true +indent_style = space +indent_size = 2 -# Space preferences -csharp_space_after_cast = false -csharp_space_after_colon_in_inheritance_clause = true -csharp_space_after_comma = true -csharp_space_after_dot = false -csharp_space_after_keywords_in_control_flow_statements = true -csharp_space_after_semicolon_in_for_statement = true -csharp_space_around_binary_operators = before_and_after -csharp_space_around_declaration_statements = do_not_ignore -csharp_space_before_colon_in_inheritance_clause = true -csharp_space_before_comma = false -csharp_space_before_dot = false -csharp_space_before_open_square_brackets = false -csharp_space_before_semicolon_in_for_statement = false -csharp_space_between_empty_square_brackets = false -csharp_space_between_method_call_empty_parameter_list_parentheses = false -csharp_space_between_method_call_name_and_opening_parenthesis = false -csharp_space_between_method_call_parameter_list_parentheses = false -csharp_space_between_method_declaration_empty_parameter_list_parentheses = false -csharp_space_between_method_declaration_name_and_open_parenthesis = false -csharp_space_between_method_declaration_parameter_list_parentheses = false -csharp_space_between_parentheses = false -csharp_space_between_square_brackets = false +[*.xml] +end_of_line = crlf +insert_final_newline = true +indent_style = space +indent_size = 2 -# Blocks are allowed -csharp_prefer_braces = true:silent -csharp_preserve_single_line_blocks = true -csharp_preserve_single_line_statements = true +[*.json] +end_of_line = crlf +insert_final_newline = true +indent_style = space +indent_size = 4 -# warning RS0037: PublicAPI.txt is missing '#nullable enable' -dotnet_diagnostic.RS0037.severity = none \ No newline at end of file +[*.yml] +end_of_line = crlf +insert_final_newline = true +indent_style = space +indent_size = 2 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1ff0c42 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,63 @@ +############################################################################### +# Set default behavior to automatically normalize line endings. +############################################################################### +* text=auto + +############################################################################### +# Set default behavior for command prompt diff. +# +# This is need for earlier builds of msysgit that does not have it on by +# default for csharp files. +# Note: This is only used by command line +############################################################################### +#*.cs diff=csharp + +############################################################################### +# Set the merge driver for project and solution files +# +# Merging from the command prompt will add diff markers to the files if there +# are conflicts (Merging from VS is not affected by the settings below, in VS +# the diff markers are never inserted). Diff markers may cause the following +# file extensions to fail to load in VS. An alternative would be to treat +# these files as binary and thus will always conflict and require user +# intervention with every merge. To do so, just uncomment the entries below +############################################################################### +#*.sln merge=binary +#*.csproj merge=binary +#*.vbproj merge=binary +#*.vcxproj merge=binary +#*.vcproj merge=binary +#*.dbproj merge=binary +#*.fsproj merge=binary +#*.lsproj merge=binary +#*.wixproj merge=binary +#*.modelproj merge=binary +#*.sqlproj merge=binary +#*.wwaproj merge=binary + +############################################################################### +# behavior for image files +# +# image files are treated as binary by default. +############################################################################### +#*.jpg binary +#*.png binary +#*.gif binary + +############################################################################### +# diff behavior for common document formats +# +# Convert binary document formats to text before diffing them. This feature +# is only available from the command line. Turn it on by uncommenting the +# entries below. +############################################################################### +#*.doc diff=astextplain +#*.DOC diff=astextplain +#*.docx diff=astextplain +#*.DOCX diff=astextplain +#*.dot diff=astextplain +#*.DOT diff=astextplain +#*.pdf diff=astextplain +#*.PDF diff=astextplain +#*.rtf diff=astextplain +#*.RTF diff=astextplain diff --git a/.github/ISSUE_TEMPLATE/ask-a-question.md b/.github/ISSUE_TEMPLATE/ask-a-question.md new file mode 100644 index 0000000..e69df3d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ask-a-question.md @@ -0,0 +1,19 @@ +--- +name: Ask a question +about: Ask us anything about KS. +title: "[Q&A] [FeatureName] - [Question]" +labels: '' +assignees: '' + +--- + +### Type of question + +- [ ] General +- [ ] API +- [ ] Commands +- [ ] Mods +- [ ] Others + +### Question + diff --git a/.github/ISSUE_TEMPLATE/report-an-issue.md b/.github/ISSUE_TEMPLATE/report-an-issue.md new file mode 100644 index 0000000..a1f3a3b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/report-an-issue.md @@ -0,0 +1,30 @@ +--- +name: Report an issue +about: Thank you for reporting a bug to us. +title: "[BUG] [featureName] - [issue]" +labels: '' +assignees: '' + +--- + +### Description + + + +### Expected behavior + + + +### Actual behavior + + + +### Steps to reproduce + +1. Open x +1. Write `yyy` +1. Observe a happening instead of z + +### Version + +Version `0.0.0 0000000000000000000000000000000000000000 main` diff --git a/.github/ISSUE_TEMPLATE/request-a-feature.md b/.github/ISSUE_TEMPLATE/request-a-feature.md new file mode 100644 index 0000000..7b1cfc2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/request-a-feature.md @@ -0,0 +1,19 @@ +--- +name: Request a feature +about: Suggest an idea to us. +title: "[ADD] [FeatureName] - [Feature]" +labels: '' +assignees: '' + +--- + +### Description of new feature + + + +### What does it add? +- [ ] New feature +- [ ] New API functions +- [ ] Others + +### Have you tried doing it? If so, attach a mod file. diff --git a/.github/funding.yml b/.github/funding.yml deleted file mode 100644 index 49ca39c..0000000 --- a/.github/funding.yml +++ /dev/null @@ -1 +0,0 @@ -github: patriksvensson \ No newline at end of file diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 0000000..805cd08 --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,21 @@ +### Description + + + +### Expected behavior + + + +### Actual behavior + + + +### Steps to reproduce + +1. Open x +1. Write `yyy` +1. Observe a happening instead of z + +### Version + +Version `0.0.0 0000000000000000000000000000000000000000 main` diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..b3cd975 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,20 @@ +## Description + + + +## Change type + +- [ ] Bug fixes +- [ ] Performance improvements +- [ ] Feature changes +- [ ] Behavioral changes +- [ ] Other (specify) + +## Tested? + +- [ ] Yes, I have +- [ ] No, I haven't +- [ ] Not sure + +## Other changes? + diff --git a/.github/workflows/build-linux-rel.yml b/.github/workflows/build-linux-rel.yml new file mode 100644 index 0000000..87c399a --- /dev/null +++ b/.github/workflows/build-linux-rel.yml @@ -0,0 +1,28 @@ +name: Build Project (Linux, Release) + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + with: + ref: ${{ github.ref }} + - name: Setup .NET + uses: actions/setup-dotnet@v3 + with: + dotnet-version: '8.0.x' + - name: Solution Compilation + run: dotnet build --configuration Release + - name: Testing + run: dotnet test --no-build --configuration Release + diff --git a/.github/workflows/build-linux.yml b/.github/workflows/build-linux.yml new file mode 100644 index 0000000..26f15f1 --- /dev/null +++ b/.github/workflows/build-linux.yml @@ -0,0 +1,33 @@ +name: Build Project (Linux) + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + with: + ref: ${{ github.ref }} + - name: Setup .NET + uses: actions/setup-dotnet@v3 + with: + dotnet-version: '8.0.x' + - name: Solution Compilation + run: dotnet build --configuration Debug + - name: Testing + run: dotnet test --configuration Debug + - uses: actions/upload-artifact@v3 + if: success() || failure() + with: + name: tr-build + path: "src/Terminaux.TermInfo/bin/Debug/" + diff --git a/.github/workflows/build-macos-rel.yml b/.github/workflows/build-macos-rel.yml new file mode 100644 index 0000000..4c5111a --- /dev/null +++ b/.github/workflows/build-macos-rel.yml @@ -0,0 +1,28 @@ +name: Build Project (macOS, Release) + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + + runs-on: macos-latest + + steps: + - uses: actions/checkout@v3 + with: + ref: ${{ github.ref }} + - name: Setup .NET + uses: actions/setup-dotnet@v3 + with: + dotnet-version: '8.0.x' + - name: Solution Compilation + run: dotnet build --configuration Release + - name: Testing + run: dotnet test --no-build --configuration Release + diff --git a/.github/workflows/build-macos.yml b/.github/workflows/build-macos.yml new file mode 100644 index 0000000..8485abf --- /dev/null +++ b/.github/workflows/build-macos.yml @@ -0,0 +1,33 @@ +name: Build Project (macOS) + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + + runs-on: macos-latest + + steps: + - uses: actions/checkout@v3 + with: + ref: ${{ github.ref }} + - name: Setup .NET + uses: actions/setup-dotnet@v3 + with: + dotnet-version: '8.0.x' + - name: Solution Compilation + run: dotnet build --configuration Debug + - name: Testing + run: dotnet test --configuration Debug + - uses: actions/upload-artifact@v3 + if: success() || failure() + with: + name: tr-build + path: "src/Terminaux.TermInfo/bin/Debug/" + diff --git a/.github/workflows/build-win-rel.yml b/.github/workflows/build-win-rel.yml new file mode 100644 index 0000000..fad4ee3 --- /dev/null +++ b/.github/workflows/build-win-rel.yml @@ -0,0 +1,28 @@ +name: Build Project (Windows, Release) + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + + runs-on: windows-latest + + steps: + - uses: actions/checkout@v3 + with: + ref: ${{ github.ref }} + - name: Setup .NET + uses: actions/setup-dotnet@v3 + with: + dotnet-version: '8.0.x' + - name: Solution Compilation + run: dotnet build --configuration Release + - name: Testing + run: dotnet test --no-build --configuration Release + diff --git a/.github/workflows/build-win.yml b/.github/workflows/build-win.yml new file mode 100644 index 0000000..06f5f84 --- /dev/null +++ b/.github/workflows/build-win.yml @@ -0,0 +1,33 @@ +name: Build Project (Windows) + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + + runs-on: windows-latest + + steps: + - uses: actions/checkout@v3 + with: + ref: ${{ github.ref }} + - name: Setup .NET + uses: actions/setup-dotnet@v3 + with: + dotnet-version: '8.0.x' + - name: Solution Compilation + run: dotnet build --configuration Debug + - name: Testing + run: dotnet test --configuration Debug + - uses: actions/upload-artifact@v3 + if: success() || failure() + with: + name: tr-build + path: "src/Terminaux.TermInfo/bin/Debug/" + diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml deleted file mode 100644 index 360e3bc..0000000 --- a/.github/workflows/ci.yaml +++ /dev/null @@ -1,38 +0,0 @@ -# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json -name: Continuous Integration -on: pull_request - -env: - # Set the DOTNET_SKIP_FIRST_TIME_EXPERIENCE environment variable to stop wasting time caching packages - DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true - # Disable sending usage data to Microsoft - DOTNET_CLI_TELEMETRY_OPTOUT: true - -jobs: - - ################################################### - # BUILD - ################################################### - - build: - name: Build - if: "!contains(github.event.head_commit.message, 'skip-ci')" - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - name: 'Get Git tags' - run: git fetch --tags - shell: bash - - - name: Setup dotnet - uses: actions/setup-dotnet@v3 - - - name: Build - shell: bash - run: | - dotnet tool restore - dotnet cake \ No newline at end of file diff --git a/.github/workflows/docgen.yml b/.github/workflows/docgen.yml new file mode 100644 index 0000000..e933d71 --- /dev/null +++ b/.github/workflows/docgen.yml @@ -0,0 +1,28 @@ +name: KS API Documentation + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + name: "Make API Reference" + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + name: Fetching the KS source + - uses: "nunit/docfx-action@master" + name: Generating documentation + with: + args: DocGen/docfx.json + - name: Saving changes to gh-pages + uses: peaceiris/actions-gh-pages@v3 + with: + commit_message: "Updated documentation to reflect latest changes" + personal_token: ${{ secrets.DOCGEN_TOKEN }} + publish_dir: ./docs/ + publish_branch: gh-pages diff --git a/.github/workflows/pack.yml b/.github/workflows/pack.yml new file mode 100644 index 0000000..600da04 --- /dev/null +++ b/.github/workflows/pack.yml @@ -0,0 +1,25 @@ +name: NuGet Gallery Push + +on: + release: + types: [published] + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + with: + ref: ${{ github.ref }} + - name: Setup .NET + uses: actions/setup-dotnet@v3 + with: + dotnet-version: '8.0.x' + - name: Solution Compilation + run: dotnet build --configuration Release + - name: Package Publication + run: | + dotnet nuget push "src/Terminaux.TermInfo/bin/Release/*.symbols.nupkg" --api-key ${{ secrets.NUGET_APIKEY }} --source "nuget.org" + diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml deleted file mode 100644 index 9c4d0db..0000000 --- a/.github/workflows/publish.yaml +++ /dev/null @@ -1,45 +0,0 @@ -# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json -name: Publish - -on: - push: - tags: - - '*' - branches: - - main - -env: - # Set the DOTNET_SKIP_FIRST_TIME_EXPERIENCE environment variable to stop wasting time caching packages - DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true - # Disable sending usage data to Microsoft - DOTNET_CLI_TELEMETRY_OPTOUT: true - -jobs: - - ################################################### - # PUBLISH - ################################################### - - publish: - name: Publish - if: "!contains(github.event.head_commit.message, 'skip-ci')" - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - name: 'Get Git tags' - run: git fetch --tags - shell: bash - - - name: Setup dotnet - uses: actions/setup-dotnet@v3 - - - name: Publish - shell: bash - run: | - dotnet tool restore - dotnet cake --target="publish" \ - --nuget-key="${{secrets.NUGET_API_KEY}}" \ No newline at end of file diff --git a/.gitignore b/.gitignore index 8c56e1c..972f6f4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,62 +1,91 @@ -# Misc folders -[Bb]in/ -[Oo]bj/ -[Tt]emp/ -[Pp]ackages/ -/.artifacts/ -/[Tt]ools/ -.idea -.DS_Store - -# Cakeup -cakeup-x86_64-latest.exe - -# .NET Core CLI -/.dotnet/ -/.packages/ -dotnet-install.sh* -*.lock.json - -# Visual Studio -.vs/ -.vscode/ -launchSettings.json -*.sln.ide/ - -# Rider -src/.idea/**/workspace.xml -src/.idea/**/tasks.xml -src/.idea/dictionaries -src/.idea/**/dataSources/ -src/.idea/**/dataSources.ids -src/.idea/**/dataSources.xml -src/.idea/**/dataSources.local.xml -src/.idea/**/sqlDataSources.xml -src/.idea/**/dynamic.xml -src/.idea/**/uiDesigner.xml - ## Ignore Visual Studio temporary files, build results, and ## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore # User-specific files +*.rsuser *.suo *.user +*.userosscache *.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) *.userprefs -*.GhostDoc.xml -*StyleCop.Cache + +# Mono auto generated files +mono_crash.* # Build results [Dd]ebug/ +!public/*/Shell/Shells/Debug/ +!public/*/Shell/Shells/Debug/** +!public/*/Shell/Prompts/Presets/Debug/ +!public/*/Shell/Prompts/Presets/Debug/** +[Dd]ebugPublic/ [Rr]elease/ +[Rr]eleases/ x64/ +x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ +KSBuild/ +KSTest/ +KSAnalyzer/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio *_i.c *_p.c +*_h.h *.ilk *.meta *.obj +*.iobj *.pch *.pdb +*.ipdb *.pgc *.pgd *.rsp @@ -65,27 +94,319 @@ x64/ *.tli *.tlh *.tmp +*.tmp_proj +*_wpftmp.csproj *.log +*.tlog *.vspscc *.vssscc .builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb # Visual Studio profiler *.psess *.vsp *.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState # ReSharper is a .NET coding add-in -_ReSharper* +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + +# Visual Studio code coverage results +*.coverage +*.coveragexml # NCrunch -.*crunch*.local.xml _NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio 6 auto-generated project file (contains which files were open etc.) +*.vbp + +# Visual Studio 6 workspace and project file (working project files containing files to include in project) +*.dsw +*.dsp + +# Visual Studio 6 technical files +*.ncb +*.aps + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# Visual Studio History (VSHistory) files +.vshistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd + +# VS Code files for those working on multiple tools +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +*.code-workspace + +# Local History for Visual Studio Code +.history/ + +# Windows Installer files from build outputs +*.cab +*.msi +*.msix +*.msm +*.msp -# NuGet Packages Directory -packages +# JetBrains Rider +*.sln.iml -# Windows -Thumbs.db +# DocGen +docs/ +DocGen/api/ -*.received.* \ No newline at end of file +# Vim +*.swp diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bcf8145 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,195 @@ +# Contributing guidelines + +First of all, thank you for contributing to our project! This kind of act is the most welcome act to help us keep running our projects the way we want them to run. All your contributions are valuable, but you need to follow these simple rules to get your contribution accepted. + +In the pull requests, we might ask you to make a few changes until we can accept them. If there's no reason for us to add your changes to the project, we might reject them altogether. + +## Following templates + +Your pull requests should follow the template. + +You should be descriptive about what your change is trying to do and what's your opinion about how it affects the whole project. Moreover, it's vital to test your changes before trying to start a pull request to ensure that there are no problems in your initial version. **Always** draft your pull requests. + +## Code guidelines + +When it comes to coding your changes, they should follow the below coding guidelines to retain the style of our projects' code. These are the below code guidelines: + +### Sorting of Fields and Properties + +Fields must come at the very beginning of each class before the properties. Between the fields and the properties and the functions, there should be an empty line. Moreover, accesibility modifiers should be sorted in the following order: + +``` +ClassName + | + |-> Public Fields + |-> Public Read-Only Fields + |-> Internal Fields + |-> Private Fields + |-> Internal Read-Only Fields + |-> Private Read-Only Fields + | + |-> Public Properties + |-> Internal Properties (rare, unless you treat them like C #macros) + | +(...) +``` + +### Sorting of Functions + +Sorting of functions is only affected by their accessibility modifiers in your code. Public functions must come before internal functions, at which the private functions come last. + +``` +(...) + | + |-> Public Functions + |-> Internal Functions + |-> Private Functions + | + --- +``` + +### Arrangement of logic in functions + +Inside functions, the arrangement of logic must be in the below order. Moreover, each part of the logic in each function must be preceded by a comment that explains why is your logic is here and a couple of necessary variables before actual logic. + +``` +ClassName +(...) + | + |-> FunctionName(int arg1, string arg2, ...) + | | + | |-> Comment explaining why (not what) is this logic here + | |-> A couple of necessary variables (optional) + | |-> Actual function logic + | | + | (...) + | +(...) +``` + +Example: + +``` +private static void PollForResize() +{ +(...) + // We need to call the WindowHeight and WindowWidth properties on the Terminal console driver, because + // this polling works for all the terminals. Other drivers that don't use the terminal may not even + // implement these two properties. + if (CurrentWindowHeight != termDriver.WindowHeight | CurrentWindowWidth != termDriver.WindowWidth) + { + ResizeDetected = true; +(...) +} +``` + +### Tabs versus Spaces + +Here we come to the argument of tabs vs spaces. Our problem with tabs is that there are systems that treat tabs as four spaces, and there are systems that treat tabs as eight spaces. Moreover, there is no universal way to accurately query the operating system for tab lengths, as such queries are up to the application handling tabs. + +We recommend that you set your IDE to use **four spaces** for each tab press. Also, don't use literal tab characters for indentation (`\t`); use four spaces. + +### Functions that do only one thing + +*This is not applicable to languages that don't support this feature* + +In C#, you can literally make a function without the opening and closing bracelets (`{ }`) if your function only contains one logic. However, you must append `=>` before the logic. Moreover, the logic should be in its own separate line with four spaces as indentation, like the following: + +``` +access_modifier [static] type SingleLogicFunctionName(string arg1, ...) => + MyLogic(arg1, ...).Modify().(...); +``` + +For example, + +``` +public static string[] GetWrappedSentences(string text, int maximumLength) => + GetWrappedSentences(text, maximumLength, 0); +``` + +### If, while, for, foreach statements that do only one thing + +*This is not applicable to languages that don't support this feature* + +In C#, you can literally make an if, while, for, and foreach statements without the opening and closing bracelets (`{ }`) if your statement only contains one logic. However, you must append `=>` before the logic. Moreover, the logic should be in its own separate line with four spaces as indentation, like the following: + +``` +if/while/for/foreach (...) + MyLogicToDo(); +``` + +For example, + +``` +// Also, compensate the \0 characters +if (text[i] == '\0') + vtSeqCompensate++; +``` + +### Naming of Public vs Internal and Private Components + +The naming must satisfy the following rules: + +* All public functions, properties, and fields must follow the Pascal Case (FunctionName) naming scheme, regardless of their purpose. +* For argument names in public, internal, and private functions, they must be named in the scheme of Camel Case (argumentName). +* Private and internal functions and properties must also follow the Pascal Case naming scheme. +* Private and internal fields must use the Camel Case naming style. +* Pascal Case should be used in class names at all times. +* You may never use the snake_case naming (this isn't Rust) or the kebab-case naming scheme (this isn't HTML) in all the components. + +To learn more about Pascal Case and Camel Case, visit [this site](https://www.freecodecamp.org/news/snake-case-vs-camel-case-vs-pascal-case-vs-kebab-case-whats-the-difference/). + +## Git commits + +We follow this conventional Git commit scheme: + +``` +Type - Attributes - Summary + +Extended Summary + +--- + +Description + +--- + +Type: Type +Breaking: Yes/No +Documentation Required: Yes/No +Part: 1/1 +``` + +For types, you should select exactly one type from the following types: + +``` +add: for additions +fix: for fixes +rem: for removals +imp: for improvements +ref: for refactors +upd: for library updates +doc: for documentation updates +``` + +Additionally, attributes are optional and can be specified. Multiple attributes should be separated with the pipe character (`|`). However, there are special cases that you may need to handle when you're committing your changes to your pull request: + +* If documentation is required (i.e. your commit requires documentation on GitBook and you've specified `doc`), change the `Documentation Required` part to `Yes`, otherwise, `No`. +* If this commit includes breaking changes (i.e. you've specified `brk`), change the `Breaking` part to `Yes`, otherwise, `No`. +* If this commit is a part of the commit series, specify `prt` and change the `Part` field where it says `1/1` to the current and the total parts in this format: `current/total`. Total parts must be accurate, and the title should stay the same as any former commits in the series. + +These are the attributes we officially support: + +``` +brk: for breaking changes +sec: for security +prf: for performance improvements +reg: for regression fixes +doc: for documentation requirement +ptp: for prototyping +prt: for commit series (PartNum is required) +``` + +## Engagement with the Community + +Thank you for your contribution to our project, but in order for this contribution to be flawless, you must be respectful to all other developers of the projects and the users in general, regardless of whether there is a fight or a heated discussion going on. Try to keep it civil during fights and don't use personal attacks, threats of any kind, derogatory and racist remarks against people or groups of any race, ethnicity, religion, or group, and explicit words (like swearing) to try to solve any disagreement with anyone, including the developers of the project. diff --git a/DocGen/.gitignore b/DocGen/.gitignore new file mode 100644 index 0000000..2a64487 --- /dev/null +++ b/DocGen/.gitignore @@ -0,0 +1,6 @@ +/**/DROP/ +/**/TEMP/ +/**/packages/ +/**/bin/ +/**/obj/ +reference \ No newline at end of file diff --git a/DocGen/docfx.json b/DocGen/docfx.json new file mode 100644 index 0000000..a155d84 --- /dev/null +++ b/DocGen/docfx.json @@ -0,0 +1,49 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ "Terminaux.TermInfo/**.csproj" ], + "src": ".." + } + ], + "dest": "api", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "filterConfig.yml" + } + ], + "build": { + "content": [ + { + "files": [ + "api/**.yml", + "index.md", + "toc.yml" + ] + } + ], + "resource": [ + { + "files": [ "images/**" ] + } + ], + "dest": "../docs", + "globalMetadata": { + "_appTitle": "Terminaux.TermInfo API - Aptivi", + "_enableSearch": true + }, + "globalMetadataFiles": [], + "fileMetadataFiles": [], + "template": [ "default" ], + "postProcessors": [], + "markdownEngineName": "markdig", + "noLangKeyword": false, + "keepFileLink": false, + "cleanupCacheHistory": false, + "disableGitFeatures": false, + "sitemap": { + "baseUrl": "https://aptivi.github.io/Terminaux.TermInfo/" + } + } +} diff --git a/DocGen/filterConfig.yml b/DocGen/filterConfig.yml new file mode 100644 index 0000000..c1e4d00 --- /dev/null +++ b/DocGen/filterConfig.yml @@ -0,0 +1,17 @@ +apiRules: +- exclude: + # inherited members from Form + uidRegex: ^System\.Windows\.Forms\.Form\..*$ + type: Member +- exclude: + # inherited members from Control + uidRegex: ^System\.Windows\.Forms\.Control\..*$ + type: Member +- exclude: + # mentioning types from System.* namespace + uidRegex: ^System\..*$ + type: Type +- exclude: + # mentioning types from Microsoft.* namespace + uidRegex: ^Microsoft\..*$ + type: Type \ No newline at end of file diff --git a/DocGen/index.md b/DocGen/index.md new file mode 100644 index 0000000..d6d4c53 --- /dev/null +++ b/DocGen/index.md @@ -0,0 +1,21 @@ +## What is Terminaux.TermInfo? + +Terminaux.TermInfo is a library that allows you to get information about each console type and their properties. + +## What is this web page? + +This webpage is an API documentation for mod developers to be used as reference. It constantly gets updated as we push the updates to the main and servicing versions of this project. + +If you still intend to use a documentation specific to your preferred version of Terminaux.TermInfo, you may refer to the [releases](https://github.com/Aptivi/Terminaux.TermInfo/releases) page of the project and download the attached `-doc.rar` file. + +To get started using the documentation, select `API Documentation` from the top menu and select a namespace to get a clear overview of the API. + +## Feedback + +If you wish to leave feedback to us about this API reference website, use the [issue tracker](https://github.com/Aptivi/Terminaux.TermInfo/issues) of the project. + +If you wish to contribute to the documentation of the API, go to the project source code and make your improvements there on a draft [Pull Request](https://github.com/Aptivi/Terminaux.TermInfo/pulls); we don't support override files that are made by clicking on `Improve this doc`. + +Any meaningful contributions are welcome. + +Copyright (c) 2022-2023 Aptivi. All rights reserved. diff --git a/DocGen/toc.yml b/DocGen/toc.yml new file mode 100644 index 0000000..3b07592 --- /dev/null +++ b/DocGen/toc.yml @@ -0,0 +1,4 @@ +- name: Home + href: index.md +- name: API Documentation + href: api/ \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..f918647 --- /dev/null +++ b/Makefile @@ -0,0 +1,33 @@ + +# Terminaux Copyright (C) 2023 Aptivi +# +# This file is part of Terminaux +# +# Terminaux 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. +# +# Terminaux 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 . + +OUTPUTS = Terminaux.*/bin Terminaux.*/obj Terminaux/bin Terminaux/obj + +.PHONY: all + +# General use + +all: all-online + +all-online: + $(MAKE) -C tools invoke-build + +clean: + rm -rf $(OUTPUTS) + +# This makefile is just a wrapper for tools scripts. diff --git a/README.md b/README.md index 4e606c8..c04a100 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,67 @@ -# terminfo -A library to read compiled, binary terminfo descriptions. +
-_[![TermInfo NuGet Version](https://img.shields.io/nuget/v/TermInfo.svg?style=flat&label=NuGet%3A%20TermInfo)](https://www.nuget.org/packages/TermInfo)_ +
+
+ + -## Usage +
-```csharp -// Load the active terminfo description -var info = TermInfoDesc.Load(); +# Terminaux.TermInfo + +*A library that allows you to inspect the TermInfo database. Part of the Terminaux library.* -// Load via terminfo name -var info = TermInfoDesc.Load("xterm-256color"); +
+
-// Default capabilities are strongly typed -Debug.Assert(info.MaxColors == 256) +[![Badge Main]][Main]    +[![Badge Main Linux]][Main Linux] -// But extended capabilities are also supported -bool? ax = info.Extended.GetBoolean("AX"); -int? u8 = info.Extended.GetNum("U8"); -string? kup = info.Extended.GetNum("kUP"); -``` +[![Badge Latest]][Latest]    +[![Badge NuGet]][NuGet] -## Building +![Badge Size]    +[![Badge Downloads]][Releases] -We're using [Cake](https://github.com/cake-build/cake) as a -[dotnet tool](https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools) -for building. So make sure that you've restored Cake by running -the following in the repository root: +[![Button Manual]][Manual]    +[![Button Libraries]][Libraries] -``` -> dotnet tool restore -``` +
+ +
-After that, running the build is as easy as writing: + -``` -> dotnet cake -``` -## Acknowledgement + -This code is partly a port of https://github.com/xo/terminfo, -licensed under [MIT](https://github.com/xo/terminfo/blob/ca9a967f877831dd8742c136f5c19f82d03673f4/LICENSE). +[Releases]: https://github.com/Aptivi/Terminaux.TermInfo/releases +[Latest]: https://github.com/Aptivi/Terminaux.TermInfo/releases/latest +[NuGet]: https://www.nuget.org/packages/Terminaux.TermInfo/ + +[Main]: https://github.com/Aptivi/Terminaux.TermInfo/actions/workflows/build-win.yml +[Main Linux]: https://github.com/Aptivi/Terminaux.TermInfo/actions/workflows/build-linux.yml + +[Libraries]: https://aptivi.gitbook.io/terminaux-manual/project-dependencies +[Manual]: https://aptivi.gitbook.io/terminaux-manual/ + + + +[Badge Downloads]: https://img.shields.io/github/downloads/Aptivi/Terminaux.TermInfo/total?color=217346&label=Downloads&style=for-the-badge&logoColor=white&logo=DocuSign&labelColor=2d9d5f +[Badge Latest]: https://img.shields.io/github/v/release/Aptivi/Terminaux.TermInfo?color=212121&include_prereleases&label=github&style=for-the-badge&logoColor=white&logo=AzureArtifacts&labelColor=303030 +[Badge NuGet]: https://img.shields.io/nuget/vpre/Terminaux.TermInfo?color=012f52&style=for-the-badge&logoColor=white&logo=NuGet&labelColor=004880 +[Badge Size]: https://img.shields.io/github/repo-size/Aptivi/Terminaux.TermInfo?color=bb4a28&label=size&logoColor=white&style=for-the-badge&logo=GoogleAnalytics&labelColor=E85C33 + +[Badge Main]: https://github.com/Aptivi/Terminaux.TermInfo/actions/workflows/build-win.yml/badge.svg +[Badge Main Linux]: https://github.com/Aptivi/Terminaux.TermInfo/actions/workflows/build-linux.yml/badge.svg + + + + +[Button Libraries]: https://img.shields.io/badge/Libraries-EA8220?style=for-the-badge&logoColor=white&logo=AzureArtifacts +[Button Manual]: https://img.shields.io/badge/Docs-blueviolet?style=for-the-badge&logoColor=white&logo=GitBook diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..51a4eca --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,19 @@ +## Reporting security problems + +Thanks for finding security problems in our project! To report them, you must look at the supported versions in our GitBook page, which can be usually accessed by going to the project's main page at GitHub and selecting `Docs`. + +In case of the libraries, only the latest versions are supported. + +### How to report? + +Good question! To report security bugs, report them in the Issues section of our project. + +1. Go to our project's GitHub page +2. Click on Issues +3. Click on `New Issue` +4. Click on `Get Started` next to `Report an issue` +5. Fill in relevant details about this security bug +6. Click on the cogwheel icon next to `Labels` and click on `SECURITY` +7. Click on `Submit new issue` + +If we can reproduce your security issue, the security advisory will be published days after review. diff --git a/aptivi_snk.snk b/aptivi_snk.snk new file mode 100644 index 0000000..b87cfc8 Binary files /dev/null and b/aptivi_snk.snk differ diff --git a/build.cake b/build.cake deleted file mode 100644 index 7d4341b..0000000 --- a/build.cake +++ /dev/null @@ -1,79 +0,0 @@ -var target = Argument("target", "Default"); -var configuration = Argument("configuration", "Release"); - -//////////////////////////////////////////////////////////////// -// Tasks - -Task("Build") - .Does(context => -{ - DotNetBuild("./src/TermInfo.sln", new DotNetBuildSettings { - Configuration = configuration, - NoIncremental = context.HasArgument("rebuild"), - MSBuildSettings = new DotNetMSBuildSettings() - .TreatAllWarningsAs(MSBuildTreatAllWarningsAs.Error) - }); -}); - -Task("Test") - .IsDependentOn("Build") - .Does(context => -{ - DotNetTest("./src/TermInfo.sln", new DotNetTestSettings { - Configuration = configuration, - NoRestore = true, - NoBuild = true, - }); -}); - -Task("Package") - .IsDependentOn("Test") - .Does(context => -{ - context.CleanDirectory("./.artifacts"); - - context.DotNetPack($"./src/TermInfo.sln", new DotNetPackSettings { - Configuration = configuration, - NoRestore = true, - NoBuild = true, - OutputDirectory = "./.artifacts", - MSBuildSettings = new DotNetMSBuildSettings() - .TreatAllWarningsAs(MSBuildTreatAllWarningsAs.Error) - }); -}); - -Task("Publish-NuGet") - .WithCriteria(ctx => BuildSystem.IsRunningOnGitHubActions, "Not running on GitHub Actions") - .IsDependentOn("Package") - .Does(context => -{ - var apiKey = Argument("nuget-key", null); - if(string.IsNullOrWhiteSpace(apiKey)) { - throw new CakeException("No NuGet API key was provided."); - } - - // Publish to GitHub Packages - foreach(var file in context.GetFiles("./.artifacts/*.nupkg")) - { - context.Information("Publishing {0}...", file.GetFilename().FullPath); - DotNetNuGetPush(file.FullPath, new DotNetNuGetPushSettings - { - Source = "https://api.nuget.org/v3/index.json", - ApiKey = apiKey, - }); - } -}); - -//////////////////////////////////////////////////////////////// -// Targets - -Task("Publish") - .IsDependentOn("Publish-NuGet"); - -Task("Default") - .IsDependentOn("Package"); - -//////////////////////////////////////////////////////////////// -// Execution - -RunTarget(target) \ No newline at end of file diff --git a/dotnet-tools.json b/dotnet-tools.json deleted file mode 100644 index 2ff67de..0000000 --- a/dotnet-tools.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "version": 1, - "isRoot": true, - "tools": { - "cake.tool": { - "version": "3.2.0", - "commands": [ - "dotnet-cake" - ] - }, - "dotnet-example": { - "version": "1.6.0", - "commands": [ - "dotnet-example" - ] - } - } -} \ No newline at end of file diff --git a/global.json b/global.json deleted file mode 100644 index bd529ac..0000000 --- a/global.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "projects": [ "src" ], - "sdk": { - "version": "8.0.100", - "rollForward": "latestMinor" - } -} \ No newline at end of file diff --git a/scripts/Generate.ps1 b/scripts/Generate.ps1 index 8b5d7f5..1895aaa 100644 --- a/scripts/Generate.ps1 +++ b/scripts/Generate.ps1 @@ -3,14 +3,14 @@ ########################################################## $Output = Join-Path $PSScriptRoot ".temp" -$Source = Join-Path $PSScriptRoot "/../src/TermInfo" +$Source = Join-Path $PSScriptRoot "/../src/Terminaux.TermInfo" if(!(Test-Path $Output -PathType Container)) { New-Item -ItemType Directory -Path $Output | Out-Null } # Generate the files -Push-Location (Join-Path $PSScriptRoot "/../src/TermInfo.Cli") +Push-Location (Join-Path $PSScriptRoot "/../src/Terminaux.TermInfo.Cli") &dotnet run generate "$Output" --input $Output if(!$?) { Pop-Location diff --git a/src/Directory.Build.props b/src/Directory.Build.props index ea5be9a..f62b1ec 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -1,24 +1,20 @@ true - 9.0 + latest true - embedded + portable true true - - true - - - A .NET library to read binary terminfo files. - Patrik Svensson, Phil Scott + A .NET library to read binary terminfo files. This library is part of the Terminaux library. + Patrik Svensson, Phil Scott, Aptivi git - https://github.com/spectreconsole/terminfo - https://github.com/spectreconsole/terminfo - MIT + https://github.com/Aptivi/Terminaux.TermInfo + https://github.com/Aptivi/Terminaux.TermInfo + GPL-3.0-or-later @@ -37,4 +33,4 @@ All - \ No newline at end of file + diff --git a/src/TermInfo/Extensions/DictionaryExtensions.cs b/src/TermInfo/Extensions/DictionaryExtensions.cs deleted file mode 100644 index 1fd2478..0000000 --- a/src/TermInfo/Extensions/DictionaryExtensions.cs +++ /dev/null @@ -1,26 +0,0 @@ -using System; -using System.Collections.Generic; - -namespace TermInfo -{ - internal static class DictionaryExtensions - { - public static Dictionary ToDictionarySafe( - this IEnumerable source, - Func keySelector, - Func valueSelector) - where TKey : notnull - { - var dictionary = new Dictionary(); - foreach (var item in source) - { - var key = keySelector(item); - var value = valueSelector(item); - - dictionary[key] = value; - } - - return dictionary; - } - } -} diff --git a/src/TermInfo/Extensions/EnumerableExtensions.cs b/src/TermInfo/Extensions/EnumerableExtensions.cs deleted file mode 100644 index aaa20d2..0000000 --- a/src/TermInfo/Extensions/EnumerableExtensions.cs +++ /dev/null @@ -1,16 +0,0 @@ -#if !NET5_0 -using System.Collections.Generic; -using System.Linq; - -namespace TermInfo -{ - internal static class EnumerableExtensions - { - public static IEnumerable<(TFirst First, TSecond Second)> Zip( - this IEnumerable source, IEnumerable first) - { - return source.Zip(first, (first, second) => (first, second)); - } - } -} -#endif \ No newline at end of file diff --git a/src/TermInfo/Extensions/ListExtensions.cs b/src/TermInfo/Extensions/ListExtensions.cs deleted file mode 100644 index 7ad3492..0000000 --- a/src/TermInfo/Extensions/ListExtensions.cs +++ /dev/null @@ -1,15 +0,0 @@ -using System.Collections.Generic; - -namespace TermInfo -{ - internal static class ListExtensions - { - public static void AddIfNotNullOrEmpty(this IList source, string? item) - { - if (source != null && !string.IsNullOrWhiteSpace(item)) - { - source.Add(item); - } - } - } -} diff --git a/src/TermInfo/Extensions/SpanExtensions.cs b/src/TermInfo/Extensions/SpanExtensions.cs deleted file mode 100644 index 69409c0..0000000 --- a/src/TermInfo/Extensions/SpanExtensions.cs +++ /dev/null @@ -1,20 +0,0 @@ -using System; - -namespace TermInfo -{ - internal static class SpanExtensions - { - public static int FindNullTerminator(this Span data, int start) - { - for (var i = start; i < data.Length; i++) - { - if (data[i] == '\0') - { - return i; - } - } - - return -1; - } - } -} diff --git a/src/TermInfo/Extensions/StringExtensions.cs b/src/TermInfo/Extensions/StringExtensions.cs deleted file mode 100644 index c7b6727..0000000 --- a/src/TermInfo/Extensions/StringExtensions.cs +++ /dev/null @@ -1,23 +0,0 @@ -using System.Text; - -namespace TermInfo -{ - internal static class StringExtensions - { - public static string ReadNullTerminatedString(this string source, int offset) - { - var accumulator = new StringBuilder(); - for (var pos = offset; pos < source.Length; pos++) - { - if (source[pos] == '\0') - { - break; - } - - accumulator.Append(source[pos]); - } - - return accumulator.ToString(); - } - } -} diff --git a/src/TermInfo/Parsing/BitWidth.cs b/src/TermInfo/Parsing/BitWidth.cs deleted file mode 100644 index 1814b78..0000000 --- a/src/TermInfo/Parsing/BitWidth.cs +++ /dev/null @@ -1,9 +0,0 @@ -namespace TermInfo -{ - internal enum BitWidth - { - OneByte = 8, - TwoBytes = 16, - FourBytes = 32, - } -} diff --git a/src/TermInfo/TermInfoCapsType.cs b/src/TermInfo/TermInfoCapsType.cs deleted file mode 100644 index b517a5e..0000000 --- a/src/TermInfo/TermInfoCapsType.cs +++ /dev/null @@ -1,24 +0,0 @@ -namespace TermInfo -{ - /// - /// Represents the different terminfo - /// capability kinds. - /// - public enum TermInfoCapsKind - { - /// - /// Boolean capability kind. - /// - Boolean = 0, - - /// - /// Num capability kind. - /// - Num = 1, - - /// - /// String capability kind. - /// - String = 2, - } -} diff --git a/src/TermInfo.Cli/.editorconfig b/src/Terminaux.TermInfo.Cli/.editorconfig similarity index 100% rename from src/TermInfo.Cli/.editorconfig rename to src/Terminaux.TermInfo.Cli/.editorconfig diff --git a/src/TermInfo.Cli/Commands/Generate/Capabilities.cs b/src/Terminaux.TermInfo.Cli/Commands/Generate/Capabilities.cs similarity index 100% rename from src/TermInfo.Cli/Commands/Generate/Capabilities.cs rename to src/Terminaux.TermInfo.Cli/Commands/Generate/Capabilities.cs diff --git a/src/TermInfo.Cli/Commands/Generate/Capability.cs b/src/Terminaux.TermInfo.Cli/Commands/Generate/Capability.cs similarity index 100% rename from src/TermInfo.Cli/Commands/Generate/Capability.cs rename to src/Terminaux.TermInfo.Cli/Commands/Generate/Capability.cs diff --git a/src/TermInfo.Cli/Commands/Generate/CapabilityType.cs b/src/Terminaux.TermInfo.Cli/Commands/Generate/CapabilityType.cs similarity index 100% rename from src/TermInfo.Cli/Commands/Generate/CapabilityType.cs rename to src/Terminaux.TermInfo.Cli/Commands/Generate/CapabilityType.cs diff --git a/src/TermInfo.Cli/Commands/Generate/GenerateCommand.cs b/src/Terminaux.TermInfo.Cli/Commands/Generate/GenerateCommand.cs similarity index 100% rename from src/TermInfo.Cli/Commands/Generate/GenerateCommand.cs rename to src/Terminaux.TermInfo.Cli/Commands/Generate/GenerateCommand.cs diff --git a/src/TermInfo.Cli/Commands/Inspect/InspectCommand.cs b/src/Terminaux.TermInfo.Cli/Commands/Inspect/InspectCommand.cs similarity index 99% rename from src/TermInfo.Cli/Commands/Inspect/InspectCommand.cs rename to src/Terminaux.TermInfo.Cli/Commands/Inspect/InspectCommand.cs index 7c1c003..797ada3 100644 --- a/src/TermInfo.Cli/Commands/Inspect/InspectCommand.cs +++ b/src/Terminaux.TermInfo.Cli/Commands/Inspect/InspectCommand.cs @@ -1,6 +1,7 @@ using System.Diagnostics; using Spectre.Console; using Spectre.Console.Cli; +using Terminaux.TermInfo; using TermInfo; namespace Generator.Commands diff --git a/src/TermInfo.Cli/Program.cs b/src/Terminaux.TermInfo.Cli/Program.cs similarity index 100% rename from src/TermInfo.Cli/Program.cs rename to src/Terminaux.TermInfo.Cli/Program.cs diff --git a/src/TermInfo.Cli/Templates/TermInfoCaps.template b/src/Terminaux.TermInfo.Cli/Templates/TermInfoCaps.template similarity index 100% rename from src/TermInfo.Cli/Templates/TermInfoCaps.template rename to src/Terminaux.TermInfo.Cli/Templates/TermInfoCaps.template diff --git a/src/TermInfo.Cli/Templates/TermInfoDesc.Generated.template b/src/Terminaux.TermInfo.Cli/Templates/TermInfoDesc.Generated.template similarity index 100% rename from src/TermInfo.Cli/Templates/TermInfoDesc.Generated.template rename to src/Terminaux.TermInfo.Cli/Templates/TermInfoDesc.Generated.template diff --git a/src/TermInfo.Cli/TermInfo.Cli.csproj b/src/Terminaux.TermInfo.Cli/Terminaux.TermInfo.Cli.csproj similarity index 93% rename from src/TermInfo.Cli/TermInfo.Cli.csproj rename to src/Terminaux.TermInfo.Cli/Terminaux.TermInfo.Cli.csproj index 5ec9fdc..d937251 100644 --- a/src/TermInfo.Cli/TermInfo.Cli.csproj +++ b/src/Terminaux.TermInfo.Cli/Terminaux.TermInfo.Cli.csproj @@ -30,7 +30,7 @@ - + diff --git a/src/TermInfo.Tests/.editorconfig b/src/Terminaux.TermInfo.Tests/.editorconfig similarity index 100% rename from src/TermInfo.Tests/.editorconfig rename to src/Terminaux.TermInfo.Tests/.editorconfig diff --git a/src/TermInfo.Tests/Data/eterm-256color b/src/Terminaux.TermInfo.Tests/Data/eterm-256color similarity index 100% rename from src/TermInfo.Tests/Data/eterm-256color rename to src/Terminaux.TermInfo.Tests/Data/eterm-256color diff --git a/src/TermInfo.Tests/Data/linux b/src/Terminaux.TermInfo.Tests/Data/linux similarity index 100% rename from src/TermInfo.Tests/Data/linux rename to src/Terminaux.TermInfo.Tests/Data/linux diff --git a/src/TermInfo.Tests/Data/windows-ansi b/src/Terminaux.TermInfo.Tests/Data/windows-ansi similarity index 100% rename from src/TermInfo.Tests/Data/windows-ansi rename to src/Terminaux.TermInfo.Tests/Data/windows-ansi diff --git a/src/TermInfo.Tests/Data/xterm+256color b/src/Terminaux.TermInfo.Tests/Data/xterm+256color similarity index 100% rename from src/TermInfo.Tests/Data/xterm+256color rename to src/Terminaux.TermInfo.Tests/Data/xterm+256color diff --git a/src/TermInfo.Tests/Data/xterm+88color b/src/Terminaux.TermInfo.Tests/Data/xterm+88color similarity index 100% rename from src/TermInfo.Tests/Data/xterm+88color rename to src/Terminaux.TermInfo.Tests/Data/xterm+88color diff --git a/src/TermInfo.Tests/TermInfoDataTests.cs b/src/Terminaux.TermInfo.Tests/TermInfoDataTests.cs similarity index 71% rename from src/TermInfo.Tests/TermInfoDataTests.cs rename to src/Terminaux.TermInfo.Tests/TermInfoDataTests.cs index 6dded95..b315ff5 100644 --- a/src/TermInfo.Tests/TermInfoDataTests.cs +++ b/src/Terminaux.TermInfo.Tests/TermInfoDataTests.cs @@ -1,7 +1,28 @@ +// +// Terminaux.TermInfo Copyright (C) 2023-2024 Aptivi +// +// This file is part of Terminaux.TermInfo +// +// Terminaux.TermInfo 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. +// +// Terminaux.TermInfo 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 . +// + using Shouldly; +using Terminaux.TermInfo.Tests.Utilities; +using TermInfo; using Xunit; -namespace TermInfo.Tests +namespace Terminaux.TermInfo.Tests { public sealed class TermInfoDataTests { @@ -9,7 +30,7 @@ public sealed class TermInfoDataTests public void Should_Read_Standard_Format() { // Given - var stream = EmbeddedResourceReader.LoadResourceStream($"TermInfo.Tests/Data/windows-ansi"); + var stream = EmbeddedResourceReader.LoadResourceStream("Terminaux.TermInfo.Tests/Data/windows-ansi"); // When var info = TermInfoDesc.Load(stream); @@ -27,7 +48,7 @@ public void Should_Read_Standard_Format() public void Should_Read_MaxColors(string terminfo, int expected) { // Given - var stream = EmbeddedResourceReader.LoadResourceStream($"TermInfo.Tests/Data/{terminfo}"); + var stream = EmbeddedResourceReader.LoadResourceStream($"Terminaux.TermInfo.Tests/Data/{terminfo}"); // When var info = TermInfoDesc.Load(stream); @@ -40,7 +61,7 @@ public void Should_Read_MaxColors(string terminfo, int expected) public void Should_Read_Extended_Capabilities() { // Given - var stream = EmbeddedResourceReader.LoadResourceStream("TermInfo.Tests/Data/eterm-256color"); + var stream = EmbeddedResourceReader.LoadResourceStream("Terminaux.TermInfo.Tests/Data/eterm-256color"); // When var info = TermInfoDesc.Load(stream); @@ -59,7 +80,7 @@ public void Should_Read_Extended_Capabilities() public void Should_Read_Extended__Capabilities_Without_String_Values() { // Given - var stream = EmbeddedResourceReader.LoadResourceStream("TermInfo.Tests/Data/linux"); + var stream = EmbeddedResourceReader.LoadResourceStream("Terminaux.TermInfo.Tests/Data/linux"); // When var info = TermInfoDesc.Load(stream); @@ -81,7 +102,7 @@ public void Should_Read_Extended__Capabilities_Without_String_Values() public void Should_Consider_Extended_Caps_Case_Sensitive(string key, bool? expected) { // Given - var stream = EmbeddedResourceReader.LoadResourceStream("TermInfo.Tests/Data/linux"); + var stream = EmbeddedResourceReader.LoadResourceStream("Terminaux.TermInfo.Tests/Data/linux"); // When var info = TermInfoDesc.Load(stream); diff --git a/src/TermInfo.Tests/TermInfo.Tests.csproj b/src/Terminaux.TermInfo.Tests/Terminaux.TermInfo.Tests.csproj similarity index 95% rename from src/TermInfo.Tests/TermInfo.Tests.csproj rename to src/Terminaux.TermInfo.Tests/Terminaux.TermInfo.Tests.csproj index a1e93dd..19c5fd6 100644 --- a/src/TermInfo.Tests/TermInfo.Tests.csproj +++ b/src/Terminaux.TermInfo.Tests/Terminaux.TermInfo.Tests.csproj @@ -42,7 +42,7 @@ - + diff --git a/src/TermInfo.Tests/Utilities/EmbeddedResourceReader.cs b/src/Terminaux.TermInfo.Tests/Utilities/EmbeddedResourceReader.cs similarity index 55% rename from src/TermInfo.Tests/Utilities/EmbeddedResourceReader.cs rename to src/Terminaux.TermInfo.Tests/Utilities/EmbeddedResourceReader.cs index 4c370d5..851f1bc 100644 --- a/src/TermInfo.Tests/Utilities/EmbeddedResourceReader.cs +++ b/src/Terminaux.TermInfo.Tests/Utilities/EmbeddedResourceReader.cs @@ -1,8 +1,27 @@ -using System; +// +// Terminaux.TermInfo Copyright (C) 2023-2024 Aptivi +// +// This file is part of Terminaux.TermInfo +// +// Terminaux.TermInfo 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. +// +// Terminaux.TermInfo 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 . +// + +using System; using System.IO; using System.Reflection; -namespace TermInfo.Tests +namespace Terminaux.TermInfo.Tests.Utilities { public static class EmbeddedResourceReader { diff --git a/src/TermInfo.sln b/src/Terminaux.TermInfo.sln similarity index 88% rename from src/TermInfo.sln rename to src/Terminaux.TermInfo.sln index 3b1eff6..d9fcdbd 100644 --- a/src/TermInfo.sln +++ b/src/Terminaux.TermInfo.sln @@ -3,11 +3,11 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 16 VisualStudioVersion = 16.6.30114.105 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TermInfo", "TermInfo\TermInfo.csproj", "{C49A39CF-372F-4E4D-AFCF-8285CFB39255}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Terminaux.TermInfo", "Terminaux.TermInfo\Terminaux.TermInfo.csproj", "{C49A39CF-372F-4E4D-AFCF-8285CFB39255}" EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TermInfo.Tests", "TermInfo.Tests\TermInfo.Tests.csproj", "{4D5E6C3E-C7AC-426C-AABE-9C44B1834C93}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Terminaux.TermInfo.Tests", "Terminaux.TermInfo.Tests\Terminaux.TermInfo.Tests.csproj", "{4D5E6C3E-C7AC-426C-AABE-9C44B1834C93}" EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TermInfo.Cli", "TermInfo.Cli\TermInfo.Cli.csproj", "{7F1EFE12-88C8-493F-8FC7-C40488179D89}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Terminaux.TermInfo.Cli", "Terminaux.TermInfo.Cli\Terminaux.TermInfo.Cli.csproj", "{7F1EFE12-88C8-493F-8FC7-C40488179D89}" EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{3D688222-B83C-4EDB-9ECD-C07CEC94FF2C}" ProjectSection(SolutionItems) = preProject diff --git a/src/TermInfo.v3.ncrunchsolution b/src/Terminaux.TermInfo.v3.ncrunchsolution similarity index 100% rename from src/TermInfo.v3.ncrunchsolution rename to src/Terminaux.TermInfo.v3.ncrunchsolution diff --git a/src/TermInfo/ExtendedCapabilities.cs b/src/Terminaux.TermInfo/ExtendedCapabilities.cs similarity index 83% rename from src/TermInfo/ExtendedCapabilities.cs rename to src/Terminaux.TermInfo/ExtendedCapabilities.cs index c4f6092..b37a45a 100644 --- a/src/TermInfo/ExtendedCapabilities.cs +++ b/src/Terminaux.TermInfo/ExtendedCapabilities.cs @@ -1,8 +1,28 @@ +// +// Terminaux.TermInfo Copyright (C) 2023-2024 Aptivi +// +// This file is part of Terminaux.TermInfo +// +// Terminaux.TermInfo 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. +// +// Terminaux.TermInfo 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 . +// + using System; using System.Collections.Generic; using System.Linq; +using Terminaux.TermInfo.Extensions; -namespace TermInfo +namespace Terminaux.TermInfo { /// /// Represents extended capabilities. diff --git a/src/Terminaux.TermInfo/Extensions/DictionaryExtensions.cs b/src/Terminaux.TermInfo/Extensions/DictionaryExtensions.cs new file mode 100644 index 0000000..f45e719 --- /dev/null +++ b/src/Terminaux.TermInfo/Extensions/DictionaryExtensions.cs @@ -0,0 +1,45 @@ +// +// Terminaux.TermInfo Copyright (C) 2023-2024 Aptivi +// +// This file is part of Terminaux.TermInfo +// +// Terminaux.TermInfo 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. +// +// Terminaux.TermInfo 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 . +// + +using System; +using System.Collections.Generic; + +namespace Terminaux.TermInfo.Extensions +{ + internal static class DictionaryExtensions + { + public static Dictionary ToDictionarySafe( + this IEnumerable source, + Func keySelector, + Func valueSelector) + where TKey : notnull + { + var dictionary = new Dictionary(); + foreach (var item in source) + { + var key = keySelector(item); + var value = valueSelector(item); + + dictionary[key] = value; + } + + return dictionary; + } + } +} diff --git a/src/Terminaux.TermInfo/Extensions/EnumerableExtensions.cs b/src/Terminaux.TermInfo/Extensions/EnumerableExtensions.cs new file mode 100644 index 0000000..8cb0c1e --- /dev/null +++ b/src/Terminaux.TermInfo/Extensions/EnumerableExtensions.cs @@ -0,0 +1,36 @@ +// +// Terminaux.TermInfo Copyright (C) 2023-2024 Aptivi +// +// This file is part of Terminaux.TermInfo +// +// Terminaux.TermInfo 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. +// +// Terminaux.TermInfo 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 . +// + +#if !NET5_0 +using System.Collections.Generic; +using System.Linq; +using Terminaux.TermInfo.Extensions; + +namespace Terminaux.TermInfo.Extensions +{ + internal static class EnumerableExtensions + { + public static IEnumerable<(TFirst First, TSecond Second)> Zip( + this IEnumerable source, IEnumerable first) + { + return source.Zip(first, (first, second) => (first, second)); + } + } +} +#endif \ No newline at end of file diff --git a/src/Terminaux.TermInfo/Extensions/ListExtensions.cs b/src/Terminaux.TermInfo/Extensions/ListExtensions.cs new file mode 100644 index 0000000..2db88f6 --- /dev/null +++ b/src/Terminaux.TermInfo/Extensions/ListExtensions.cs @@ -0,0 +1,34 @@ +// +// Terminaux.TermInfo Copyright (C) 2023-2024 Aptivi +// +// This file is part of Terminaux.TermInfo +// +// Terminaux.TermInfo 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. +// +// Terminaux.TermInfo 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 . +// + +using System.Collections.Generic; + +namespace Terminaux.TermInfo.Extensions +{ + internal static class ListExtensions + { + public static void AddIfNotNullOrEmpty(this IList source, string? item) + { + if (source != null && !string.IsNullOrWhiteSpace(item)) + { + source.Add(item); + } + } + } +} diff --git a/src/Terminaux.TermInfo/Extensions/SpanExtensions.cs b/src/Terminaux.TermInfo/Extensions/SpanExtensions.cs new file mode 100644 index 0000000..30bb26f --- /dev/null +++ b/src/Terminaux.TermInfo/Extensions/SpanExtensions.cs @@ -0,0 +1,39 @@ +// +// Terminaux.TermInfo Copyright (C) 2023-2024 Aptivi +// +// This file is part of Terminaux.TermInfo +// +// Terminaux.TermInfo 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. +// +// Terminaux.TermInfo 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 . +// + +using System; + +namespace Terminaux.TermInfo.Extensions +{ + internal static class SpanExtensions + { + public static int FindNullTerminator(this Span data, int start) + { + for (var i = start; i < data.Length; i++) + { + if (data[i] == '\0') + { + return i; + } + } + + return -1; + } + } +} diff --git a/src/Terminaux.TermInfo/Extensions/StringExtensions.cs b/src/Terminaux.TermInfo/Extensions/StringExtensions.cs new file mode 100644 index 0000000..6b5d50f --- /dev/null +++ b/src/Terminaux.TermInfo/Extensions/StringExtensions.cs @@ -0,0 +1,42 @@ +// +// Terminaux.TermInfo Copyright (C) 2023-2024 Aptivi +// +// This file is part of Terminaux.TermInfo +// +// Terminaux.TermInfo 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. +// +// Terminaux.TermInfo 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 . +// + +using System.Text; + +namespace Terminaux.TermInfo.Extensions +{ + internal static class StringExtensions + { + public static string ReadNullTerminatedString(this string source, int offset) + { + var accumulator = new StringBuilder(); + for (var pos = offset; pos < source.Length; pos++) + { + if (source[pos] == '\0') + { + break; + } + + accumulator.Append(source[pos]); + } + + return accumulator.ToString(); + } + } +} diff --git a/src/Terminaux.TermInfo/OfficialAppIcon-Terminaux-512.png b/src/Terminaux.TermInfo/OfficialAppIcon-Terminaux-512.png new file mode 100644 index 0000000..fb0536d Binary files /dev/null and b/src/Terminaux.TermInfo/OfficialAppIcon-Terminaux-512.png differ diff --git a/src/Terminaux.TermInfo/Parsing/BitWidth.cs b/src/Terminaux.TermInfo/Parsing/BitWidth.cs new file mode 100644 index 0000000..e569df7 --- /dev/null +++ b/src/Terminaux.TermInfo/Parsing/BitWidth.cs @@ -0,0 +1,28 @@ +// +// Terminaux.TermInfo Copyright (C) 2023-2024 Aptivi +// +// This file is part of Terminaux.TermInfo +// +// Terminaux.TermInfo 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. +// +// Terminaux.TermInfo 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 . +// + +namespace Terminaux.TermInfo.Parsing +{ + internal enum BitWidth + { + OneByte = 8, + TwoBytes = 16, + FourBytes = 32, + } +} diff --git a/src/TermInfo/Parsing/ByteReader.cs b/src/Terminaux.TermInfo/Parsing/ByteReader.cs similarity index 57% rename from src/TermInfo/Parsing/ByteReader.cs rename to src/Terminaux.TermInfo/Parsing/ByteReader.cs index 3659a6b..3006c64 100644 --- a/src/TermInfo/Parsing/ByteReader.cs +++ b/src/Terminaux.TermInfo/Parsing/ByteReader.cs @@ -1,7 +1,26 @@ +// +// Terminaux.TermInfo Copyright (C) 2023-2024 Aptivi +// +// This file is part of Terminaux.TermInfo +// +// Terminaux.TermInfo 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. +// +// Terminaux.TermInfo 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 . +// + using System; using System.IO; -namespace TermInfo +namespace Terminaux.TermInfo.Parsing { internal sealed class ByteReader { diff --git a/src/TermInfo/Parsing/NullTerminatedIndexedString.cs b/src/Terminaux.TermInfo/Parsing/NullTerminatedIndexedString.cs similarity index 65% rename from src/TermInfo/Parsing/NullTerminatedIndexedString.cs rename to src/Terminaux.TermInfo/Parsing/NullTerminatedIndexedString.cs index d72b122..42b8f89 100644 --- a/src/TermInfo/Parsing/NullTerminatedIndexedString.cs +++ b/src/Terminaux.TermInfo/Parsing/NullTerminatedIndexedString.cs @@ -1,6 +1,25 @@ +// +// Terminaux.TermInfo Copyright (C) 2023-2024 Aptivi +// +// This file is part of Terminaux.TermInfo +// +// Terminaux.TermInfo 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. +// +// Terminaux.TermInfo 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 . +// + using System; -namespace TermInfo +namespace Terminaux.TermInfo.Parsing { internal sealed class NullTerminatedIndexedString { diff --git a/src/TermInfo/Parsing/TermInfoParser.cs b/src/Terminaux.TermInfo/Parsing/TermInfoParser.cs similarity index 89% rename from src/TermInfo/Parsing/TermInfoParser.cs rename to src/Terminaux.TermInfo/Parsing/TermInfoParser.cs index 0871225..1456cc0 100644 --- a/src/TermInfo/Parsing/TermInfoParser.cs +++ b/src/Terminaux.TermInfo/Parsing/TermInfoParser.cs @@ -1,10 +1,29 @@ -// Ported from https://github.com/xo/terminfo/blob/master/gen.go +// +// Terminaux.TermInfo Copyright (C) 2023-2024 Aptivi +// +// This file is part of Terminaux.TermInfo +// +// Terminaux.TermInfo 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. +// +// Terminaux.TermInfo 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 . +// using System; using System.IO; using System.Text; +using Terminaux.TermInfo.Extensions; +using TermInfo; -namespace TermInfo +namespace Terminaux.TermInfo.Parsing { internal static class TermInfoParser { diff --git a/src/TermInfo/TermInfoCaps.cs b/src/Terminaux.TermInfo/TermInfoCaps.cs similarity index 100% rename from src/TermInfo/TermInfoCaps.cs rename to src/Terminaux.TermInfo/TermInfoCaps.cs diff --git a/src/Terminaux.TermInfo/TermInfoCapsType.cs b/src/Terminaux.TermInfo/TermInfoCapsType.cs new file mode 100644 index 0000000..39b1e1e --- /dev/null +++ b/src/Terminaux.TermInfo/TermInfoCapsType.cs @@ -0,0 +1,43 @@ +// +// Terminaux.TermInfo Copyright (C) 2023-2024 Aptivi +// +// This file is part of Terminaux.TermInfo +// +// Terminaux.TermInfo 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. +// +// Terminaux.TermInfo 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 . +// + +namespace Terminaux.TermInfo +{ + /// + /// Represents the different terminfo + /// capability kinds. + /// + public enum TermInfoCapsKind + { + /// + /// Boolean capability kind. + /// + Boolean = 0, + + /// + /// Num capability kind. + /// + Num = 1, + + /// + /// String capability kind. + /// + String = 2, + } +} diff --git a/src/TermInfo/TermInfoDesc.Generated.cs b/src/Terminaux.TermInfo/TermInfoDesc.Generated.cs similarity index 100% rename from src/TermInfo/TermInfoDesc.Generated.cs rename to src/Terminaux.TermInfo/TermInfoDesc.Generated.cs diff --git a/src/TermInfo/TermInfoDesc.Static.cs b/src/Terminaux.TermInfo/TermInfoDesc.Static.cs similarity index 83% rename from src/TermInfo/TermInfoDesc.Static.cs rename to src/Terminaux.TermInfo/TermInfoDesc.Static.cs index 22beb94..7ecf3c2 100644 --- a/src/TermInfo/TermInfoDesc.Static.cs +++ b/src/Terminaux.TermInfo/TermInfoDesc.Static.cs @@ -1,5 +1,25 @@ +// +// Terminaux.TermInfo Copyright (C) 2023-2024 Aptivi +// +// This file is part of Terminaux.TermInfo +// +// Terminaux.TermInfo 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. +// +// Terminaux.TermInfo 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 . +// + using System; using System.IO; +using Terminaux.TermInfo; namespace TermInfo { diff --git a/src/TermInfo/TermInfoDesc.cs b/src/Terminaux.TermInfo/TermInfoDesc.cs similarity index 76% rename from src/TermInfo/TermInfoDesc.cs rename to src/Terminaux.TermInfo/TermInfoDesc.cs index c7561e1..1d2a799 100644 --- a/src/TermInfo/TermInfoDesc.cs +++ b/src/Terminaux.TermInfo/TermInfoDesc.cs @@ -1,3 +1,24 @@ +// +// Terminaux.TermInfo Copyright (C) 2023-2024 Aptivi +// +// This file is part of Terminaux.TermInfo +// +// Terminaux.TermInfo 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. +// +// Terminaux.TermInfo 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 . +// + +using Terminaux.TermInfo; + namespace TermInfo { /// @@ -84,11 +105,6 @@ internal TermInfoDesc( } var result = _strings[index]; - if (result == null) - { - return null; - } - return result; } } diff --git a/src/TermInfo/TermInfoLoader.cs b/src/Terminaux.TermInfo/TermInfoLoader.cs similarity index 75% rename from src/TermInfo/TermInfoLoader.cs rename to src/Terminaux.TermInfo/TermInfoLoader.cs index 12336c5..2f1dbaf 100644 --- a/src/TermInfo/TermInfoLoader.cs +++ b/src/Terminaux.TermInfo/TermInfoLoader.cs @@ -1,9 +1,31 @@ +// +// Terminaux.TermInfo Copyright (C) 2023-2024 Aptivi +// +// This file is part of Terminaux.TermInfo +// +// Terminaux.TermInfo 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. +// +// Terminaux.TermInfo 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 . +// + using System; using System.Collections.Generic; using System.IO; using System.Runtime.InteropServices; +using Terminaux.TermInfo.Extensions; +using Terminaux.TermInfo.Parsing; +using TermInfo; -namespace TermInfo +namespace Terminaux.TermInfo { internal static class TermInfoLoader { diff --git a/src/TermInfo/TermInfo.csproj b/src/Terminaux.TermInfo/Terminaux.TermInfo.csproj similarity index 51% rename from src/TermInfo/TermInfo.csproj rename to src/Terminaux.TermInfo/Terminaux.TermInfo.csproj index a9ce66a..de21b11 100644 --- a/src/TermInfo/TermInfo.csproj +++ b/src/Terminaux.TermInfo/Terminaux.TermInfo.csproj @@ -1,8 +1,19 @@ - + - net8.0;netstandard2.0 + netstandard2.0 enable + 2.6.0 + console;shell;readline;gnu;cui;tui;cli;manipulation;console;vt;sequences;color;vt100;truecolor;library;csharp;reader;input;writer;styles;formatter + True + True + Aptivi + Copyright (c) 2022-2023 Aptivi. + README.md + True + OfficialAppIcon-Terminaux-512.png + True + ..\..\aptivi_snk.snk @@ -29,4 +40,18 @@ False + + + True + \ + + + + + + True + \ + + + diff --git a/tools/Makefile b/tools/Makefile new file mode 100644 index 0000000..31b7b2f --- /dev/null +++ b/tools/Makefile @@ -0,0 +1,27 @@ + +# Terminaux Copyright (C) 2023 Aptivi +# +# This file is part of Terminaux +# +# Terminaux 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. +# +# Terminaux 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 . + +# Below is a workaround for .NET SDK 7.0 trying to allocate large amounts of memory for GC work: +# https://github.com/dotnet/runtime/issues/85556#issuecomment-1529177092 +DOTNET_PAGE_SIZE = $(shell getconf PAGESIZE) +DOTNET_AVPHYS_PAGES = $(shell getconf _AVPHYS_PAGES) +DOTNET_HEAP_LIMIT = $(shell printf '%X\n' $$(($(DOTNET_AVPHYS_PAGES) * $(DOTNET_PAGE_SIZE)))) + +invoke-build: + chmod +x ./build.sh + ./build.sh || (echo Retrying with heap limit 0x$(DOTNET_HEAP_LIMIT)... && DOTNET_GCHeapHardLimit=$(DOTNET_HEAP_LIMIT) ./build.sh) diff --git a/tools/build.cmd b/tools/build.cmd new file mode 100644 index 0000000..5580f16 --- /dev/null +++ b/tools/build.cmd @@ -0,0 +1,40 @@ +@echo off + +REM Terminaux.TermInfo Copyright (C) 2018-2021 Aptivi +REM +REM This file is part of Terminaux.TermInfo +REM +REM Terminaux.TermInfo is free software: you can redistribute it and/or modify +REM it under the terms of the GNU General Public License as published by +REM the Free Software Foundation, either version 3 of the License, or +REM (at your option) any later version. +REM +REM Terminaux.TermInfo is distributed in the hope that it will be useful, +REM but WITHOUT ANY WARRANTY; without even the implied warranty of +REM MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +REM GNU General Public License for more details. +REM +REM You should have received a copy of the GNU General Public License +REM along with this program. If not, see . + +REM This script builds and packs the artifacts. Use when you have VS installed. +set releaseconfig=%1 +if "%releaseconfig%" == "" set releaseconfig=Release + +:download +echo Downloading packages... +"%ProgramFiles%\dotnet\dotnet.exe" msbuild "..\src\Terminaux.TermInfo.sln" -t:restore -p:Configuration=%releaseconfig% +if %errorlevel% == 0 goto :build +echo There was an error trying to download packages (%errorlevel%). +goto :finished + +:build +echo Building... +"%ProgramFiles%\dotnet\dotnet.exe" msbuild "..\src\Terminaux.TermInfo.sln" -p:Configuration=%releaseconfig% +if %errorlevel% == 0 goto :success +echo There was an error trying to build (%errorlevel%). +goto :finished + +:success +echo Build successful. +:finished diff --git a/tools/build.sh b/tools/build.sh new file mode 100644 index 0000000..0bb1eb6 --- /dev/null +++ b/tools/build.sh @@ -0,0 +1,51 @@ +#!/bin/bash + +# Terminaux.TermInfo Copyright (C) 2023 Aptivi +# +# This file is part of Terminaux.TermInfo +# +# Terminaux.TermInfo 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. +# +# Terminaux.TermInfo 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 . + +# This script builds. Use when you have dotnet installed. +releaseconf=$1 +if [ -z $releaseconf ]; then + releaseconf=Release +fi + +# Check for dependencies +dotnetpath=`which dotnet` +if [ ! $? == 0 ]; then + echo dotnet is not found. + exit 1 +fi + +# Download packages +echo Downloading packages... +"$dotnetpath" msbuild "../src/Terminaux.TermInfo.sln" -t:restore -p:Configuration=$releaseconf +if [ ! $? == 0 ]; then + echo Download failed. + exit 1 +fi + +# Build KS +echo Building KS... +"$dotnetpath" msbuild "../src/Terminaux.TermInfo.sln" -p:Configuration=$releaseconf +if [ ! $? == 0 ]; then + echo Build failed. + exit 1 +fi + +# Inform success +echo Build successful. +exit 0 diff --git a/tools/docgen-pack.cmd b/tools/docgen-pack.cmd new file mode 100644 index 0000000..3309565 --- /dev/null +++ b/tools/docgen-pack.cmd @@ -0,0 +1,22 @@ +@echo off + +REM This script builds KS documentation and packs the artifacts. Use when you have VS installed. +for /f "tokens=* USEBACKQ" %%f in (`type version`) do set ksversion=%%f + +:pack +echo Packing documentation... +"%ProgramFiles%\7-Zip\7z.exe" a -tzip %temp%/%ksversion%-doc.zip "..\docs\*" +if %errorlevel% == 0 goto :finalize +echo There was an error trying to pack documentation (%errorlevel%). +goto :finished + +:finalize +rmdir /S /Q "..\DocGen\api\" +rmdir /S /Q "..\DocGen\obj\" +rmdir /S /Q "..\docs\" +move %temp%\%ksversion%-doc.zip +echo Build and pack successful. +goto :finished + +:finished +pause diff --git a/tools/docgen-pack.sh b/tools/docgen-pack.sh new file mode 100644 index 0000000..7ac1782 --- /dev/null +++ b/tools/docgen-pack.sh @@ -0,0 +1,27 @@ +#!/bin/bash + +# This script builds KS and packs the artifacts. Use when you have MSBuild installed. +ksversion=$(cat version) + +# Check for dependencies +zippath=`which zip` +if [ ! $? == 0 ]; then + echo zip is not found. + exit 1 +fi + +# Pack documentation +echo Packing documentation... +cd "../docs/" && "$zippath" -r /tmp/$ksversion-doc.zip . && cd - +if [ ! $? == 0 ]; then + echo Packing failed. + exit 1 +fi + +# Inform success +rm -rf "../DocGen/api" +rm -rf "../DocGen/obj" +rm -rf "../docs" +mv /tmp/$ksversion-doc.zip . +echo Pack successful. +exit 0 diff --git a/tools/docgen.cmd b/tools/docgen.cmd new file mode 100644 index 0000000..1b04209 --- /dev/null +++ b/tools/docgen.cmd @@ -0,0 +1,36 @@ +@echo off + +REM Terminaux Copyright (C) 2018-2022 Aptivi +REM +REM This file is part of Terminaux +REM +REM Terminaux is free software: you can redistribute it and/or modify +REM it under the terms of the GNU General Public License as published by +REM the Free Software Foundation, either version 3 of the License, or +REM (at your option) any later version. +REM +REM Terminaux is distributed in the hope that it will be useful, +REM but WITHOUT ANY WARRANTY; without even the implied warranty of +REM MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +REM GNU General Public License for more details. +REM +REM You should have received a copy of the GNU General Public License +REM along with this program. If not, see . + +REM This script builds documentation and packs the artifacts. + +echo Finding DocFX... +if exist %ProgramData%\chocolatey\bin\docfx.exe goto :build +echo You don't have DocFX installed. Download and install Chocolatey and DocFX. +goto :finished + +:build +echo Building Documentation... +%ProgramData%\chocolatey\bin\docfx.exe "..\DocGen\docfx.json" +if %errorlevel% == 0 goto :success +echo There was an error trying to build documentation (%errorlevel%). +goto :finished + +:success +echo Build and pack successful. +:finished diff --git a/tools/docgen.sh b/tools/docgen.sh new file mode 100644 index 0000000..bdac5a0 --- /dev/null +++ b/tools/docgen.sh @@ -0,0 +1,37 @@ +#!/bin/bash + +# Terminaux Copyright (C) 2023 Aptivi +# +# This file is part of Terminaux +# +# Terminaux 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. +# +# Terminaux 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 . + +# Check for dependencies +msbuildpath=`which docfx` +if [ ! $? == 0 ]; then + echo DocFX is not found. + exit 1 +fi + +# Build KS +echo Building documentation... +docfx DocGen/docfx.json +if [ ! $? == 0 ]; then + echo Build failed. + exit 1 +fi + +# Inform success +echo Build successful. +exit 0 diff --git a/tools/pack.cmd b/tools/pack.cmd new file mode 100644 index 0000000..5714343 --- /dev/null +++ b/tools/pack.cmd @@ -0,0 +1,37 @@ +@echo off + +REM Terminaux.TermInfo Copyright (C) 2018-2021 Aptivi +REM +REM This file is part of Terminaux.TermInfo +REM +REM Terminaux.TermInfo is free software: you can redistribute it and/or modify +REM it under the terms of the GNU General Public License as published by +REM the Free Software Foundation, either version 3 of the License, or +REM (at your option) any later version. +REM +REM Terminaux.TermInfo is distributed in the hope that it will be useful, +REM but WITHOUT ANY WARRANTY; without even the implied warranty of +REM MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +REM GNU General Public License for more details. +REM +REM You should have received a copy of the GNU General Public License +REM along with this program. If not, see . + +for /f "tokens=* USEBACKQ" %%f in (`type version`) do set version=%%f +set releaseconfig=%1 +if "%releaseconfig%" == "" set releaseconfig=Release + +:packbin +echo Packing binary... +"%ProgramFiles%\7-Zip\7z.exe" a -tzip %temp%/%version%-bin.zip "..\src\Terminaux.TermInfo\bin\%releaseconfig%\netstandard2.0\*" +"%ProgramFiles%\7-Zip\7z.exe" a -tzip %temp%/%version%-demo.zip "..\src\Terminaux.TermInfo.Cli\bin\%releaseconfig%\net8.0\*" +if %errorlevel% == 0 goto :complete +echo There was an error trying to pack binary (%errorlevel%). +goto :finished + +:complete +move %temp%\%version%-bin.zip +move %temp%\%version%-demo.zip + +echo Pack successful. +:finished diff --git a/tools/pack.sh b/tools/pack.sh new file mode 100644 index 0000000..db124ed --- /dev/null +++ b/tools/pack.sh @@ -0,0 +1,47 @@ +#!/bin/bash + +# Terminaux.TermInfo Copyright (C) 2023 Aptivi +# +# This file is part of Terminaux.TermInfo +# +# Terminaux.TermInfo 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. +# +# Terminaux.TermInfo 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 . + +# This script builds and packs the artifacts. Use when you have MSBuild installed. +version=$(cat version) +releaseconf=$1 +if [ -z $releaseconf ]; then + releaseconf=Release +fi + +# Check for dependencies +zippath=`which zip` +if [ ! $? == 0 ]; then + echo zip is not found. + exit 1 +fi + +# Pack binary +echo Packing binary... +cd "../src/Terminaux.TermInfo/bin/$releaseconf/netstandard2.0/" && "$zippath" -r /tmp/$version-bin.zip . && cd - +cd "../src/Terminaux.TermInfo.Cli/bin/$releaseconf/net8.0/" && "$zippath" -r /tmp/$version-demo.zip . && cd - +if [ ! $? == 0 ]; then + echo Packing using zip failed. + exit 1 +fi + +# Inform success +mv /tmp/$version-bin.zip . +mv /tmp/$version-demo.zip . +echo Build and pack successful. +exit 0 diff --git a/tools/version b/tools/version new file mode 100644 index 0000000..e70b452 --- /dev/null +++ b/tools/version @@ -0,0 +1 @@ +2.6.0