diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..ee1a591 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,40 @@ +name: Bug report +description: Something is not working as expected. +title: Description of the bug +labels: bug + +body: + - type: textarea + attributes: + label: Describe the bug + description: >- + A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + attributes: + label: To Reproduce + description: >- + Steps to reproduce the behavior. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + + - type: textarea + attributes: + label: Expected behavior + description: >- + A clear and concise description of what you expected to happen. + validations: + required: true + + - type: textarea + attributes: + label: Additional context + description: >- + Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/component_request.yml b/.github/ISSUE_TEMPLATE/component_request.yml new file mode 100644 index 0000000..cca6a9a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/component_request.yml @@ -0,0 +1,37 @@ +name: Components request +description: Suggest an idea for a new component +title: Description of the component request +labels: enhancement + +body: + - type: textarea + attributes: + label: Why would you like to add a new component? + placeholder: >- + A clear and concise description of why the component should be added. + validations: + required: false + + - type: textarea + attributes: + label: Name the native widgets. + placeholder: >- + A list of the native widgets of Gtk/Libadwaita or AppKit, if you know them. + validations: + required: true + + - type: textarea + attributes: + label: Describe your idea for the implementation. + placeholder: >- + What could the implementation be like in Dvandva? + validations: + required: false + + - type: textarea + attributes: + label: Additional context + placeholder: >- + Add any other context about the component request here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..c244dbb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,36 @@ +name: Feature request +description: Suggest an idea for this project +title: Description of the feature request +labels: enhancement + +body: + - type: input + attributes: + label: Is your feature request related to a problem? Please describe. + placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: false + + - type: textarea + attributes: + label: Describe the solution you'd like + placeholder: >- + A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + attributes: + label: Describe alternatives you've considered + placeholder: >- + A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true + + - type: textarea + attributes: + label: Additional context + placeholder: >- + Add any other context or screenshots about the feature request here. + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..f0ed3f3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ +## Steps +- [ ] Add your name or username and a link to your GitHub profile into the [Contributors.md][1] file. +- [ ] Build the project on your machine. If it does not compile, fix the errors. +- [ ] Describe the purpose and approach of your pull request below. +- [ ] Submit the pull request. Thank you very much for your contribution! + +## Purpose +_Describe the problem or feature._ +_If there is a related issue, add the link._ + +## Approach +_Describe how this pull request solves the problem or adds the feature._ + +[1]: /Contributors.md diff --git a/.github/workflows/swiftlint.yml b/.github/workflows/swiftlint.yml new file mode 100644 index 0000000..5348bdb --- /dev/null +++ b/.github/workflows/swiftlint.yml @@ -0,0 +1,30 @@ +name: SwiftLint + +on: + push: + paths: + - '.github/workflows/swiftlint.yml' + - '.swiftlint.yml' + - '**/*.swift' + pull_request: + paths: + - '.github/workflows/swiftlint.yml' + - '.swiftlint.yml' + - '**/*.swift' + workflow_dispatch: + paths: + - '.github/workflows/swiftlint.yml' + - '.swiftlint.yml' + - '**/*.swift' + +jobs: + SwiftLint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - name: SwiftLint + uses: norio-nomura/action-swiftlint@3.2.1 + with: + args: --strict + env: + WORKING_DIRECTORY: Source diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..831c525 --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +.DS_Store +/.build +/Packages +/*.xcodeproj +xcuserdata/ +DerivedData/ +/.swiftpm +.netrc +/Package.resolved +.Ulysses-Group.plist diff --git a/.swiftlint.yml b/.swiftlint.yml new file mode 100644 index 0000000..596994d --- /dev/null +++ b/.swiftlint.yml @@ -0,0 +1,162 @@ +# Opt-In Rules +opt_in_rules: + - anonymous_argument_in_multiline_closure + - array_init + - attributes + - closure_body_length + - closure_end_indentation + - closure_spacing + - collection_alignment + - comma_inheritance + - conditional_returns_on_newline + - contains_over_filter_count + - contains_over_filter_is_empty + - contains_over_first_not_nil + - contains_over_range_nil_comparison + - convenience_type + - discouraged_none_name + - discouraged_object_literal + - discouraged_optional_boolean + - discouraged_optional_collection + - empty_collection_literal + - empty_count + - empty_string + - enum_case_associated_values_count + - explicit_init + - fallthrough + - file_header + - file_name + - file_name_no_space + - first_where + - flatmap_over_map_reduce + - force_unwrapping + - function_default_parameter_at_end + - identical_operands + - implicit_return + - implicitly_unwrapped_optional + - joined_default_parameter + - last_where + - legacy_multiple + - let_var_whitespace + - literal_expression_end_indentation + - local_doc_comment + - lower_acl_than_parent + - missing_docs + - modifier_order + - multiline_arguments + - multiline_arguments_brackets + - multiline_function_chains + - multiline_literal_brackets + - multiline_parameters + - multiline_parameters_brackets + - no_extension_access_modifier + - no_grouping_extension + - no_magic_numbers + - number_separator + - operator_usage_whitespace + - optional_enum_case_matching + - prefer_self_in_static_references + - prefer_self_type_over_type_of_self + - prefer_zero_over_explicit_init + - prohibited_interface_builder + - redundant_nil_coalescing + - redundant_type_annotation + - return_value_from_void_function + - shorthand_optional_binding + - sorted_first_last + - sorted_imports + - static_operator + - strict_fileprivate + - switch_case_on_newline + - toggle_bool + - trailing_closure + - type_contents_order + - unneeded_parentheses_in_closure_argument + - yoda_condition + +# Disabled Rules +disabled_rules: + - block_based_kvo + - class_delegate_protocol + - dynamic_inline + - is_disjoint + - no_fallthrough_only + - notification_center_detachment + - ns_number_init_as_function_reference + - nsobject_prefer_isequal + - private_over_fileprivate + - redundant_objc_attribute + - self_in_property_initialization + - todo + - unavailable_condition + - valid_ibinspectable + - xctfail_message + +# Custom Rules +custom_rules: + github_issue: + name: 'GitHub Issue' + regex: '//.(TODO|FIXME):.(?!.*(https://github\.com/Aparoksha/CodeEditor/issues/\d))' + message: 'The related GitHub issue must be included in a TODO or FIXME.' + severity: warning + + fatal_error: + name: 'Fatal Error' + regex: 'fatalError.*\(.*\)' + message: 'Fatal error should not be used.' + severity: error + + enum_case_parameter: + name: 'Enum Case Parameter' + regex: 'case [a-zA-Z0-9]*\([a-zA-Z0-9\.<>?,\n\t =]+\)' + message: 'The associated values of an enum case should have parameters.' + severity: warning + + tab: + name: 'Whitespaces Instead of Tab' + regex: '\t' + message: 'Spaces should be used instead of tabs.' + severity: warning + + # Thanks to the creator of the SwiftLint rule + # "empty_first_line" + # https://github.com/coteditor/CotEditor/blob/main/.swiftlint.yml + # in the GitHub repository + # "CotEditor" + # https://github.com/coteditor/CotEditor + empty_first_line: + name: 'Empty First Line' + regex: '(^[ a-zA-Z ]*(?:protocol|extension|class|struct) (?!(?:var|let))[ a-zA-Z:]*\{\n *\S+)' + message: 'There should be an empty line after a declaration' + severity: error + +# Analyzer Rules +analyzer_rules: + - unused_declaration + - unused_import + +# Options +file_header: + required_pattern: '(// swift-tools-version: .+)?//\n// .*.swift\n// CodeEditor\n//\n// Created by .* on .*\.(\n// Edited by (.*,)+\.)*\n(\n// Thanks to .* for the .*:\n// ".*"\n// https://.* \(\d\d.\d\d.\d\d\))*//\n' +missing_docs: + warning: [internal, private] + error: [open, public] + excludes_extensions: false + excludes_inherited_types: false +type_contents_order: + order: + - case + - type_alias + - associated_type + - type_property + - instance_property + - ib_inspectable + - ib_outlet + - subscript + - initializer + - deinitializer + - subtype + - type_method + - view_life_cycle_method + - ib_action + - other_method diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c43eec3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ +# Contributing + +Thank you very much for taking the time for contributing to this project. + +## Report a Bug +Just open a new issue on GitHub and describe the bug. It helps if your description is detailed. Thank you very much for your contribution! + +## Suggest a New Feature +Just open a new issue on GitHub and describe the idea. Thank you very much for your contribution! + +## Pull Requests +I am happy for every pull request, you do not have to follow these guidelines. However, it might help you to understand the project structure and make it easier for me to merge your pull request. Thank you very much for your contribution! + +### 1. Fork & Clone this Project +Start by clicking on the `Fork` button at the top of the page. Then, clone this repository to your computer. + +### 2. Open the Project +Open the project folder in GNOME Builder, Xcode or another IDE. + +### 3. Understand the Project Structure +- The `README.md` file contains a description of the app or package. +- The `Contributors.md` file contains the names or user names of all the contributors with a link to their GitHub profile. +- The `LICENSE.md` contains an GPL-3.0 license. +- `CONTRIBUTING.md` is this file. +- Directory `Icons` that contains PNG and PXD (Pixelmator Pro) files for the images used in the app and guides. +- Directory `Documentation` that contains the documentation generated with [SourceDocs][1]. +- `Sources` contains the source code of the project. +- `Tests` contains an example application. + +### 4. Edit the Code +Edit the code. If you add a new type, add documentation in the code. + +### 5. Commit to the Fork +Commit and push the fork. + +### 6. Pull Request +Open GitHub to submit a pull request. Thank you very much for your contribution! + +[1]: https://github.com/SourceDocs/SourceDocs diff --git a/Contributors.md b/Contributors.md new file mode 100644 index 0000000..3cf3f03 --- /dev/null +++ b/Contributors.md @@ -0,0 +1,3 @@ +# Contributors + +- [david-swift](https://github.com/david-swift) diff --git a/Documentation/CodeEditor/README.md b/Documentation/CodeEditor/README.md new file mode 100644 index 0000000..6ead94c --- /dev/null +++ b/Documentation/CodeEditor/README.md @@ -0,0 +1,7 @@ +# Reference Documentation + +## Structs + +- [CodeEditor](structs/CodeEditor.md) + +This file was generated by [SourceDocs](https://github.com/eneko/SourceDocs) \ No newline at end of file diff --git a/Documentation/CodeEditor/structs/CodeEditor.md b/Documentation/CodeEditor/structs/CodeEditor.md new file mode 100644 index 0000000..ba5e098 --- /dev/null +++ b/Documentation/CodeEditor/structs/CodeEditor.md @@ -0,0 +1,65 @@ +**STRUCT** + +# `CodeEditor` + +A text or code editor widget. + +## Properties +### `text` + +The editor's content. + +### `padding` + +The padding between the border and the content. + +### `paddingEdges` + +The edges affected by the padding. + +### `numbers` + +Whether the line numbers are visible. + +### `language` + +The programming language for syntax highlighting. + +## Methods +### `init(text:)` + +Initialize a code editor. +- Parameter text: The editor's content. + +### `container(modifiers:)` + +Get the editor's view storage. +- Parameter modifiers: The view modifiers. +- Returns: The view storage. + +### `update(_:modifiers:)` + +Update a view storage to the editor. +- Parameters: + - storage: The view storage. + - modifiers: The view modifiers. + +### `innerPadding(_:edges:)` + +Add padding between the editor's content and border. +- Parameters: + - padding: The padding's value. + - edges: The affected edges. +- Returns: The editor. + +### `lineNumbers(_:)` + +Set the visibility of line numbers. +- Parameter visible: Whether the numbers are visible. +- Returns: The editor. + +### `language(_:)` + +Set the syntax highlighting programming language. +- Parameter language: The programming language. +- Returns: The editor. diff --git a/Documentation/CodeEditorFoundation/README.md b/Documentation/CodeEditorFoundation/README.md new file mode 100644 index 0000000..829b8de --- /dev/null +++ b/Documentation/CodeEditorFoundation/README.md @@ -0,0 +1,16 @@ +# Reference Documentation + +## Classes + +- [CodeBuffer](classes/CodeBuffer.md) +- [CodeEditor](classes/CodeEditor.md) + +## Enums + +- [Language](enums/Language.md) + +## Methods + +- [buffer_on_change_cb(ptr_userData_)](methods/buffer_on_change_cb(ptr_userData_).md) + +This file was generated by [SourceDocs](https://github.com/eneko/SourceDocs) \ No newline at end of file diff --git a/Documentation/CodeEditorFoundation/classes/CodeBuffer.md b/Documentation/CodeEditorFoundation/classes/CodeBuffer.md new file mode 100644 index 0000000..64b2e58 --- /dev/null +++ b/Documentation/CodeEditorFoundation/classes/CodeBuffer.md @@ -0,0 +1,39 @@ +**CLASS** + +# `CodeBuffer` + +GtkSource.Buffer + +## Properties +### `handlers` + +The handlers being called when the content changes. + +## Methods +### `init()` + +Initialize a code buffer. + +### `getText()` + +Get the content of the buffer. +- Returns: The content. + +### `setText(_:)` + +Set the content of the buffer. +- Parameter text: The new content. + +### `changeHandler(_:)` + +Add a handler that gets called when the content changes. +- Parameter handler: The handler. + +### `setLanguage(_:)` + +Set the buffer's programming language. +- Parameter language: The programming language. + +### `onChange()` + +This function gets called when the content changes and updates the handlers. diff --git a/Documentation/CodeEditorFoundation/classes/CodeEditor.md b/Documentation/CodeEditorFoundation/classes/CodeEditor.md new file mode 100644 index 0000000..28bfbc6 --- /dev/null +++ b/Documentation/CodeEditorFoundation/classes/CodeEditor.md @@ -0,0 +1,51 @@ +**CLASS** + +# `CodeEditor` + +GtkSource.View + +## Properties +### `buffer` + +The source view's code buffer. + +## Methods +### `init()` + +Initialize a code editor. + +### `innerPadding(_:_:)` + +Set the padding between the editor's border and the text. +- Parameters: + - padding: The value of the padding. + - edges: The edges that should be affected. +- Returns: The editor + +### `lineNumbers(_:)` + +Set whether the editor shows the line numbers. +- Parameter visible: Whether the line numbers are visible. +- Returns: The editor. + +### `getText()` + +Get the editor's content text. +- Returns: The text. + +### `setText(_:)` + +Set the editor's content text. +- Parameter text: The editor's content. + +### `changeHandler(_:)` + +Add a handler that gets called when the content text changes. +- Parameter handler: The handler. +- Returns: The editor. + +### `setLanguage(_:)` + +Set the syntax highlighting programming language. +- Parameter language: The programming language. +- Returns: The editor. diff --git a/Documentation/CodeEditorFoundation/enums/Language.md b/Documentation/CodeEditorFoundation/enums/Language.md new file mode 100644 index 0000000..cd6f1b3 --- /dev/null +++ b/Documentation/CodeEditorFoundation/enums/Language.md @@ -0,0 +1,361 @@ +**ENUM** + +# `Language` + +A language available in the code editor. + +## Cases +### `abnf` + +### `actionscript` + +### `ada` + +### `ansforth94` + +### `asciidoc` + +### `asp` + +### `automake` + +### `awk` + +### `bennugd` + +### `bibtex` + +### `blueprint` + +### `bluespec` + +### `boo` + +### `c` + +### `cSharp` + +### `cpp` + +### `cg` + +### `changelog` + +### `changes` + +### `cpphdr` + +### `cmake` + +### `chdr` + +### `cobol` + +### `commonlisp` + +### `css` + +### `csv` + +### `cuda` + +### `d` + +### `dart` + +### `def` + +### `desktop` + +### `diff` + +### `dtl` + +### `docbook` + +### `docker` + +### `dosbatch` + +### `dpatch` + +### `dtd` + +### `eiffel` + +### `erb` + +### `erbHtml` + +### `erbJs` + +### `erlang` + +### `fsharp` + +### `fcl` + +### `fish` + +### `ftl` + +### `forth` + +### `fortran` + +### `gap` + +### `gdbLog` + +### `gdscript` + +### `genie` + +### `gettextTranslation` + +### `go` + +### `gradle` + +### `dot` + +### `groovy` + +### `gtkDoc` + +### `gtkrc` + +### `haddock` + +### `haskell` + +### `haxe` + +### `html` + +### `idl` + +### `idlExelis` + +### `imagej` + +### `ini` + +### `j` + +### `jade` + +### `java` + +### `js` + +### `jsVal` + +### `jsExpr` + +### `jsFn` + +### `jsLit` + +### `jsMod` + +### `jsSt` + +### `jsdoc` + +### `json` + +### `jsx` + +### `julia` + +### `kotlin` + +### `latex` + +### `lean` + +### `less` + +### `lex` + +### `libtool` + +### `haskellLiterate` + +### `llvm` + +### `logcat` + +### `logtalk` + +### `lua` + +### `m4` + +### `makefile` + +### `mallard` + +### `markdown` + +### `matlab` + +### `maxima` + +### `mediawiki` + +### `meson` + +### `modelica` + +### `mxml` + +### `nemerle` + +### `netrexx` + +### `nix` + +### `nsis` + +### `objc` + +### `objj` + +### `ocaml` + +### `ocl` + +### `octave` + +### `ooc` + +### `opal` + +### `openclGlsl` + +### `pascal` + +### `perl` + +### `php` + +### `pig` + +### `pkgconfig` + +### `plain` + +### `powershell` + +### `prolog` + +### `proto` + +### `puppet` + +### `python3` + +### `python` + +### `r` + +### `reasonml` + +### `rst` + +### `rpmspec` + +### `ruby` + +### `rust` + +### `scala` + +### `scheme` + +### `scilab` + +### `scss` + +### `sh` + +### `solidity` + +### `sparql` + +### `spice` + +### `sql` + +### `sml` + +### `star` + +### `sweave` + +### `swift` + +### `systemverilog` + +### `tcl` + +### `tera` + +### `terraform` + +### `texinfo` + +### `thrift` + +### `todotxt` + +### `toml` + +### `twig` + +### `t2t` + +### `typescript` + +### `typescriptJsExpr` + +### `typescriptJsFn` + +### `typescriptJsLit` + +### `typescriptJsMod` + +### `typescriptJsSt` + +### `typescriptJsx` + +### `typescriptTypeExpr` + +### `typescriptTypeGen` + +### `typescriptTypeLit` + +### `vala` + +### `vbnet` + +### `verilog` + +### `vhdl` + +### `xml` + +### `xslt` + +### `yacc` + +### `yaml` + +### `yara` + +## Properties +### `languageName` + +The name of the language for the backend. diff --git a/Documentation/CodeEditorFoundation/methods/buffer_on_change_cb(ptr_userData_).md b/Documentation/CodeEditorFoundation/methods/buffer_on_change_cb(ptr_userData_).md new file mode 100644 index 0000000..150db14 --- /dev/null +++ b/Documentation/CodeEditorFoundation/methods/buffer_on_change_cb(ptr_userData_).md @@ -0,0 +1,6 @@ +### `buffer_on_change_cb(ptr:userData:)` + +This function gets called when the content changes. +- Parameters: + - ptr: The pointer. + - userData: Data about the buffer. diff --git a/Icons/CodeEditorIcon.png b/Icons/CodeEditorIcon.png new file mode 100644 index 0000000..8a92902 Binary files /dev/null and b/Icons/CodeEditorIcon.png differ diff --git a/Icons/CodeEditorIcon.pxd b/Icons/CodeEditorIcon.pxd new file mode 100644 index 0000000..917d468 Binary files /dev/null and b/Icons/CodeEditorIcon.pxd differ diff --git a/Icons/GitHubBanner.png b/Icons/GitHubBanner.png new file mode 100644 index 0000000..efa3f64 Binary files /dev/null and b/Icons/GitHubBanner.png differ diff --git a/Icons/GitHubBanner.pxd b/Icons/GitHubBanner.pxd new file mode 100644 index 0000000..4aafed8 Binary files /dev/null and b/Icons/GitHubBanner.pxd differ diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..10926e8 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,675 @@ + 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..84f0ac0 --- /dev/null +++ b/Makefile @@ -0,0 +1,9 @@ +docs: + @sourcedocs generate --min-acl private -r --spm-module CodeEditorFoundation --output-folder Documentation/CodeEditorFoundation + @sourcedocs generate --min-acl private -r --spm-module CodeEditor --output-folder Documentation/CodeEditor + +swiftlint: + @swiftlint --autocorrect + +format: + @clang-format -i Sources/CCodeEditor/shim.h --style=file diff --git a/Package.swift b/Package.swift new file mode 100644 index 0000000..1adac96 --- /dev/null +++ b/Package.swift @@ -0,0 +1,47 @@ +// swift-tools-version: 5.8 +// +// Package.swift +// CodeEditor +// +// Created by david-swift on 27.11.23. +// + +import PackageDescription + +/// The CodeEditor package. +let package = Package( + name: "CodeEditor", + products: [ + .library( + name: "CodeEditor", + targets: ["CodeEditor"] + ), + .library( + name: "CodeEditorFoundation", + targets: ["CodeEditorFoundation"] + ) + ], + dependencies: [ + .package(url: "https://github.com/AparokshaUI/Adwaita", from: "0.1.4"), + .package(url: "https://github.com/AparokshaUI/Libadwaita", from: "0.1.1") + ], + targets: [ + .target( + name: "CodeEditor", + dependencies: ["CodeEditorFoundation", .product(name: "Adwaita", package: "Adwaita")] + ), + .target( + name: "CodeEditorFoundation", + dependencies: ["CCodeEditor", .product(name: "Libadwaita", package: "Libadwaita")] + ), + .systemLibrary( + name: "CCodeEditor", + pkgConfig: "gtksourceview-5" + ), + .executableTarget( + name: "Test", + dependencies: ["CodeEditor", "Adwaita"], + path: "Tests" + ) + ] +) diff --git a/README.md b/README.md new file mode 100644 index 0000000..467e0bd --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +

+ CodeEditor Icon +

CodeEditor

+

+ +

+ + GitHub + + · + + CodeEditor Docs + + · + + CodeEditorFoundation Docs + +

+ +_CodeEditor_ adds support for text and code editors to GNOME apps built using [Adwaita](https://github.com/AparokshaUI/Adwaita) (declarative) or [Libadwaita](https://github.com/AparokshaUI/Libadwaita) (imperative). + +## Table of Contents + +- [Installation](#Installation) +- [Usage](#Usage) +- [Thanks](#Thanks) + +## Installation +### Dependencies +Install `gtksourceview-devel` or similar (based on the package manager) as well as `gtk4-devel` and `libadwaita-devel` (or similar). + +### Swift Package +1. Open your Swift package in GNOME Builder, or any other IDE. +2. Open the `Package.swift` file. +3. Into the `Package` initializer, under `dependencies`, paste: +```swift +.package(url: "https://github.com/AparokshaUI/CodeEditor", from: "0.1.0") +``` + +## Usage + +Take a look at the simple [sample app](Tests/main.swift). If you prefer an imperative over a declarative coding style, import the `CodeEditorFoundation` instead. +Check out the [Adwaita](https://github.com/AparokshaUI/Adwaita) (declarative) or [Libadwaita](https://github.com/AparokshaUI/Libadwaita) (imperative) packages. + +## Thanks + +### Dependencies +- [Adwaita](https://github.com/AparokshaUI/Adwaita) licensed under the [GPL-3.0 license](https://github.com/AparokshaUI/Adwaita/blob/main/LICENSE.md) +- [Libadwaita](https://github.com/AparokshaUI/Libadwaita) licensed under the [GPL-3.0 license](https://github.com/AparokshaUI/Libadwaita/blob/main/LICENSE.md) + +### Other Thanks +- The [contributors](Contributors.md) +- [SwiftLint](https://github.com/realm/SwiftLint) for checking whether code style conventions are violated +- The programming language [Swift](https://github.com/apple/swift) +- [SourceDocs](https://github.com/SourceDocs/SourceDocs) used for generating the [docs](Documentation/Reference/README.md) +- [GtkSourceView](https://gitlab.gnome.org/GNOME/gtksourceview/) for the widgets diff --git a/Sources/CCodeEditor/module.modulemap b/Sources/CCodeEditor/module.modulemap new file mode 100644 index 0000000..3d68077 --- /dev/null +++ b/Sources/CCodeEditor/module.modulemap @@ -0,0 +1,5 @@ +module CCodeEditor [system] { + header "shim.h" + link "gtksourceview-5" + export * +} \ No newline at end of file diff --git a/Sources/CCodeEditor/shim.h b/Sources/CCodeEditor/shim.h new file mode 100644 index 0000000..265eff4 --- /dev/null +++ b/Sources/CCodeEditor/shim.h @@ -0,0 +1,147 @@ +#pragma once +#include + +static void buffer_on_change_cb(void *, void *); + +static uint64_t codeeditor_init(uint64_t buffer) { + g_assert_nonnull(buffer); + g_assert(GTK_SOURCE_IS_BUFFER(GTK_SOURCE_BUFFER((void *)buffer))); + + return (uint64_t)gtk_source_view_new_with_buffer(buffer); +} + +static void codeeditor_set_top_margin(uint64_t codeeditor, int padding) { + g_assert_nonnull(codeeditor); + g_assert(GTK_SOURCE_IS_VIEW(GTK_SOURCE_VIEW((void *)codeeditor))); + + gtk_text_view_set_top_margin(codeeditor, padding); +} + +static void codeeditor_set_bottom_margin(uint64_t codeeditor, int padding) { + g_assert_nonnull(codeeditor); + g_assert(GTK_SOURCE_IS_VIEW(GTK_SOURCE_VIEW((void *)codeeditor))); + + gtk_text_view_set_bottom_margin(codeeditor, padding); +} + +static void codeeditor_set_leading_margin(uint64_t codeeditor, int padding) { + g_assert_nonnull(codeeditor); + g_assert(GTK_SOURCE_IS_VIEW(GTK_SOURCE_VIEW((void *)codeeditor))); + + gtk_text_view_set_left_margin(codeeditor, padding); +} + +static void codeeditor_set_trailing_margin(uint64_t codeeditor, int padding) { + g_assert_nonnull(codeeditor); + g_assert(GTK_SOURCE_IS_VIEW(GTK_SOURCE_VIEW((void *)codeeditor))); + + gtk_text_view_set_right_margin(codeeditor, padding); +} + +static void codeeditor_set_line_numbers(uint64_t codeeditor, + gboolean show_line_numbers) { + g_assert_nonnull(codeeditor); + g_assert(GTK_SOURCE_IS_VIEW(GTK_SOURCE_VIEW((void *)codeeditor))); + + gtk_source_view_set_show_line_numbers(codeeditor, show_line_numbers); +} + +static uint64_t codeeditor_init_buffer() { + return (uint64_t)gtk_source_buffer_new(NULL); +} + +static void codeeditor_buffer_init_signals(uint64_t buffer, uint64_t data) { + GtkTextBuffer *text_buffer; + + g_assert_nonnull(buffer); + g_assert_nonnull(data); + g_assert(GTK_SOURCE_IS_BUFFER(GTK_SOURCE_BUFFER((void *)buffer))); + + text_buffer = GTK_SOURCE_BUFFER(buffer); + swift_retain(data); + g_signal_connect(text_buffer, "changed", G_CALLBACK(buffer_on_change_cb), + (void *)data); +} + +static const char *codeeditor_buffer_get_text(uint64_t buffer) { + g_assert_nonnull(buffer); + g_assert(GTK_SOURCE_IS_BUFFER(GTK_SOURCE_BUFFER((void *)buffer))); + + GtkTextIter start_iter; + GtkTextIter end_iter; + + gtk_text_buffer_get_start_iter(buffer, &start_iter); + gtk_text_buffer_get_end_iter(buffer, &end_iter); + + return gtk_text_buffer_get_text(buffer, &start_iter, &end_iter, TRUE); +} + +static void codeeditor_buffer_set_text(uint64_t buffer, const char *text) { + g_assert_nonnull(buffer); + g_assert_nonnull(text); + g_assert(GTK_SOURCE_IS_BUFFER(GTK_SOURCE_BUFFER((void *)buffer))); + + gtk_text_buffer_set_text(buffer, text, -1); +} + +static void codeeditor_buffer_set_language(uint64_t buffer, + const char *language) { + g_assert_nonnull(buffer); + g_assert(GTK_SOURCE_IS_BUFFER(GTK_SOURCE_BUFFER((void *)buffer))); + g_assert_nonnull(language); + + GtkSourceLanguageManager *lang_manager = + gtk_source_language_manager_get_default(); + GtkSourceBuffer *source_buffer = GTK_SOURCE_BUFFER(buffer); + + GtkSourceLanguage *lang = + gtk_source_language_manager_get_language(lang_manager, language); + gtk_source_buffer_set_language(source_buffer, lang); +} + +static void update_theme_on_settings_change(GObject *settings, + GParamSpec *pspec, + gpointer user_data) { + GtkSourceBuffer *source_buffer = GTK_SOURCE_BUFFER(user_data); + g_assert_nonnull(source_buffer); + + gboolean is_dark_mode = FALSE; + g_object_get(G_OBJECT(settings), "gtk-application-prefer-dark-theme", + &is_dark_mode, NULL); + + const char *theme_name = is_dark_mode ? "Adwaita-dark" : "Adwaita"; + + GtkSourceStyleSchemeManager *scheme_manager = + gtk_source_style_scheme_manager_get_default(); + GtkSourceStyleScheme *style_scheme = + gtk_source_style_scheme_manager_get_scheme(scheme_manager, theme_name); + gtk_source_buffer_set_style_scheme(source_buffer, style_scheme); +} + +static void codeeditor_buffer_set_theme_adaptive(uint64_t buffer) { + g_assert_nonnull(buffer); + g_assert(GTK_SOURCE_IS_BUFFER(GTK_SOURCE_BUFFER((void *)buffer))); + + GtkSourceBuffer *source_buffer = GTK_SOURCE_BUFFER(buffer); + + GtkSettings *settings = gtk_settings_get_default(); + gboolean is_dark_mode = FALSE; + g_object_get(G_OBJECT(settings), "gtk-application-prefer-dark-theme", + &is_dark_mode, NULL); + + const char *theme_name = is_dark_mode ? "Adwaita-dark" : "Adwaita"; + + GtkSourceStyleSchemeManager *scheme_manager = + gtk_source_style_scheme_manager_get_default(); + GtkSourceStyleScheme *style_scheme = + gtk_source_style_scheme_manager_get_scheme(scheme_manager, theme_name); + gtk_source_buffer_set_style_scheme(source_buffer, style_scheme); + + g_signal_connect(settings, "notify::gtk-application-prefer-dark-theme", + G_CALLBACK(update_theme_on_settings_change), source_buffer); +} + +static void print_language_id(gpointer data, gpointer user_data) { + const gchar *language_id = (const gchar *)data; + g_print("%s\n", language_id); +} diff --git a/Sources/CodeEditor/CodeEditor.swift b/Sources/CodeEditor/CodeEditor.swift new file mode 100644 index 0000000..d77a28d --- /dev/null +++ b/Sources/CodeEditor/CodeEditor.swift @@ -0,0 +1,92 @@ +// +// CodeEditor.swift +// CodeEditor +// +// Created by david-swift on 27.11.23. +// + +import Adwaita +import CodeEditorFoundation +import Libadwaita + +/// A text or code editor widget. +public struct CodeEditor: Widget { + + /// The editor's content. + @Binding var text: String + /// The padding between the border and the content. + var padding = 0 + /// The edges affected by the padding. + var paddingEdges: Set = [] + /// Whether the line numbers are visible. + var numbers = false + /// The programming language for syntax highlighting. + var language: Language = .plain + + /// Initialize a code editor. + /// - Parameter text: The editor's content. + public init(text: Binding) { + self._text = text + } + + /// Get the editor's view storage. + /// - Parameter modifiers: The view modifiers. + /// - Returns: The view storage. + public func container(modifiers: [(View) -> View]) -> ViewStorage { + let editor = CodeEditorFoundation.CodeEditor() + _ = editor.changeHandler { + self.text = editor.getText() + } + editor.setText(text) + _ = editor + .innerPadding(padding, paddingEdges) + .lineNumbers(numbers) + .setLanguage(language) + return .init(editor) + } + + /// Update a view storage to the editor. + /// - Parameters: + /// - storage: The view storage. + /// - modifiers: The view modifiers. + public func update(_ storage: ViewStorage, modifiers: [(View) -> View]) { + if let editor = storage.view as? CodeEditorFoundation.CodeEditor, editor.getText() != text { + editor.setText(text) + _ = editor + .innerPadding(padding, paddingEdges) + .lineNumbers(numbers) + .setLanguage(language) + } + } + + /// Add padding between the editor's content and border. + /// - Parameters: + /// - padding: The padding's value. + /// - edges: The affected edges. + /// - Returns: The editor. + public func innerPadding(_ padding: Int = 10, edges: Set = .all) -> Self { + var newSelf = self + newSelf.padding = padding + newSelf.paddingEdges = edges + return newSelf + } + + /// Set the visibility of line numbers. + /// - Parameter visible: Whether the numbers are visible. + /// - Returns: The editor. + public func lineNumbers(_ visible: Bool = true) -> Self { + var newSelf = self + newSelf.numbers = visible + return newSelf + } + + /// Set the syntax highlighting programming language. + /// - Parameter language: The programming language. + /// - Returns: The editor. + public func language(_ language: Language) -> Self { + var newSelf = self + newSelf.language = language + return newSelf + } + +} diff --git a/Sources/CodeEditorFoundation/CodeBuffer.swift b/Sources/CodeEditorFoundation/CodeBuffer.swift new file mode 100644 index 0000000..2a8f18f --- /dev/null +++ b/Sources/CodeEditorFoundation/CodeBuffer.swift @@ -0,0 +1,70 @@ +// +// CodeBuffer.swift +// CodeEditor +// +// Created by david-swift on 27.11.23. +// + +import CCodeEditor +import Libadwaita + +/// GtkSource.Buffer +class CodeBuffer: NativeWidgetPeer { + + /// The handlers being called when the content changes. + var handlers: [() -> Void] = [] + + /// Initialize a code buffer. + override init() { + super.init() + nativePtr = codeeditor_init_buffer() + let selfAddr = unsafeBitCast(self, to: UInt64.self) + codeeditor_buffer_init_signals(nativePtr, selfAddr) + codeeditor_buffer_set_theme_adaptive(nativePtr) + } + + /// Get the content of the buffer. + /// - Returns: The content. + func getText() -> String { + .init(cString: codeeditor_buffer_get_text(nativePtr)) + } + + /// Set the content of the buffer. + /// - Parameter text: The new content. + func setText(_ text: String) { + codeeditor_buffer_set_text(nativePtr, text) + } + + /// Add a handler that gets called when the content changes. + /// - Parameter handler: The handler. + func changeHandler(_ handler: @escaping () -> Void) { + handlers.append(handler) + } + + /// Set the buffer's programming language. + /// - Parameter language: The programming language. + func setLanguage(_ language: Language) { + codeeditor_buffer_set_language(nativePtr, language.languageName) + } + + /// This function gets called when the content changes and updates the handlers. + func onChange() { + for handler in handlers { + handler() + } + } + +} + +/// This function gets called when the content changes. +/// - Parameters: +/// - ptr: The pointer. +/// - userData: Data about the buffer. +@_cdecl("buffer_on_change_cb") +func buffer_on_change_cb( + ptr: UnsafeMutableRawPointer, + userData: UnsafeMutableRawPointer +) { + let editor = Unmanaged.fromOpaque(userData).takeUnretainedValue() + editor.onChange() +} diff --git a/Sources/CodeEditorFoundation/CodeEditor.swift b/Sources/CodeEditorFoundation/CodeEditor.swift new file mode 100644 index 0000000..ad547c3 --- /dev/null +++ b/Sources/CodeEditorFoundation/CodeEditor.swift @@ -0,0 +1,81 @@ +// +// CodeEditor.swift +// CodeEditor +// +// Created by david-swift on 27.11.23. +// + +import CCodeEditor +import Libadwaita + +/// GtkSource.View +public class CodeEditor: NativeWidgetPeer { + + /// The source view's code buffer. + let buffer = CodeBuffer() + + /// Initialize a code editor. + override public init() { + super.init() + nativePtr = codeeditor_init(buffer.nativePtr) + } + + /// Set the padding between the editor's border and the text. + /// - Parameters: + /// - padding: The value of the padding. + /// - edges: The edges that should be affected. + /// - Returns: The editor + public func innerPadding(_ padding: Int = 10, _ edges: Set = .all) -> Self { + let padding = Int32(padding) + for edge in edges { + switch edge { + case .top: + codeeditor_set_top_margin(nativePtr, padding) + case .bottom: + codeeditor_set_bottom_margin(nativePtr, padding) + case .leading: + codeeditor_set_leading_margin(nativePtr, padding) + case .trailing: + codeeditor_set_trailing_margin(nativePtr, padding) + } + } + return self + } + + /// Set whether the editor shows the line numbers. + /// - Parameter visible: Whether the line numbers are visible. + /// - Returns: The editor. + public func lineNumbers(_ visible: Bool = true) -> Self { + codeeditor_set_line_numbers(nativePtr, visible ? 1 : 0) + return self + } + + /// Get the editor's content text. + /// - Returns: The text. + public func getText() -> String { + buffer.getText() + } + + /// Set the editor's content text. + /// - Parameter text: The editor's content. + public func setText(_ text: String) { + buffer.setText(text) + } + + /// Add a handler that gets called when the content text changes. + /// - Parameter handler: The handler. + /// - Returns: The editor. + public func changeHandler(_ handler: @escaping () -> Void) -> Self { + buffer.changeHandler(handler) + return self + } + + /// Set the syntax highlighting programming language. + /// - Parameter language: The programming language. + /// - Returns: The editor. + public func setLanguage(_ language: Language) -> Self { + buffer.setLanguage(language) + return self + } + +} diff --git a/Sources/CodeEditorFoundation/Language.swift b/Sources/CodeEditorFoundation/Language.swift new file mode 100644 index 0000000..82468a5 --- /dev/null +++ b/Sources/CodeEditorFoundation/Language.swift @@ -0,0 +1,206 @@ +// +// Language.swift +// CodeEditor +// +// Created by david-swift on 28.11.23. +// + +/// A language available in the code editor. +public enum Language: String { + + // swiftlint:disable missing_docs identifier_name + + case abnf + case actionscript + case ada + case ansforth94 + case asciidoc + case asp + case automake + case awk + case bennugd + case bibtex + case blueprint + case bluespec + case boo + case c + case cSharp + case cpp + case cg + case changelog + case changes + case cpphdr + case cmake + case chdr + case cobol + case commonlisp + case css + case csv + case cuda + case d + case dart + case def + case desktop + case diff + case dtl + case docbook + case docker + case dosbatch + case dpatch + case dtd + case eiffel + case erb + case erbHtml + case erbJs + case erlang + case fsharp + case fcl + case fish + case ftl + case forth + case fortran + case gap + case gdbLog + case gdscript + case genie + case gettextTranslation + case go + case gradle + case dot + case groovy + case gtkDoc + case gtkrc + case haddock + case haskell + case haxe + case html + case idl + case idlExelis + case imagej + case ini + case j + case jade + case java + case js + case jsVal + case jsExpr + case jsFn + case jsLit + case jsMod + case jsSt + case jsdoc + case json + case jsx + case julia + case kotlin + case latex + case lean + case less + case lex + case libtool + case haskellLiterate + case llvm + case logcat + case logtalk + case lua + case m4 + case makefile + case mallard + case markdown + case matlab + case maxima + case mediawiki + case meson + case modelica + case mxml + case nemerle + case netrexx + case nix + case nsis + case objc + case objj + case ocaml + case ocl + case octave + case ooc + case opal + case openclGlsl + case pascal + case perl + case php + case pig + case pkgconfig + case plain + case powershell + case prolog + case proto + case puppet + case python3 + case python + case r + case reasonml + case rst + case rpmspec + case ruby + case rust + case scala + case scheme + case scilab + case scss + case sh + case solidity + case sparql + case spice + case sql + case sml + case star + case sweave + case swift + case systemverilog + case tcl + case tera + case terraform + case texinfo + case thrift + case todotxt + case toml + case twig + case t2t + case typescript + case typescriptJsExpr + case typescriptJsFn + case typescriptJsLit + case typescriptJsMod + case typescriptJsSt + case typescriptJsx + case typescriptTypeExpr + case typescriptTypeGen + case typescriptTypeLit + case vala + case vbnet + case verilog + case vhdl + case xml + case xslt + case yacc + case yaml + case yara + + // swiftlint:enable missing_docs identifier_name + + /// The name of the language for the backend. + var languageName: String { + let camelCase = self.rawValue + var dashedString = "" + + for (index, char) in camelCase.enumerated() { + if index > 0 && char.isUppercase { + dashedString += "-\(char.lowercased())" + } else { + dashedString += String(char) + } + } + + return dashedString + } +} diff --git a/Tests/main.swift b/Tests/main.swift new file mode 100644 index 0000000..3c8b4cd --- /dev/null +++ b/Tests/main.swift @@ -0,0 +1,49 @@ +// +// main.swift +// CodeEditor +// +// Created by david-swift on 27.11.23. +// + +import Adwaita +import CodeEditor +import Libadwaita + +// swiftlint:disable missing_docs implicitly_unwrapped_optional no_magic_numbers + +@main +struct Test: App { + + let id = "io.foo.Bar" + @State private var text = "" + var app: GTUIApp! + + var scene: Scene { + Window(id: "main") { window in + ScrollView { + CodeEditor(text: $text) + .innerPadding() + .lineNumbers() + .language(.swift) + } + .topToolbar { + HeaderBar.start { + Button("Print", icon: .default(icon: .printer)) { + print(text) + } + .keyboardShortcut("Return".ctrl(), app: app) + .style("suggested-action") + } + } + .inspect { _ = ($0 as? ToolbarView)?.topBarStyle(.raised) } + .onAppear { + window.setDefaultSize(width: 300, height: 250) + } + } + .closeShortcut() + .quitShortcut() + } + +} + +// swiftlint:enable missing_docs implicitly_unwrapped_optional no_magic_numbers