From 822c227d0bccd6118c33a535b0de58d3d685b367 Mon Sep 17 00:00:00 2001 From: rdipardo <59004801+rdipardo@users.noreply.github.com> Date: Wed, 4 Sep 2024 13:32:20 -0400 Subject: [PATCH] Remove all GPL-licensed contributions TL;DR A GPL-covered project can legally include Apache-covered third-party code, but *not* vice versa [^1] --- Using any GPL code requires that the *whole* project be GPL-licensed, a change only the original author of the abandoned template can make A purely Apache-licensed package is better for: 1. upstreaming improvements to the current .NET Framework template; 2. developing closed-source plugins, as some devs have already done with the .NET Framework template, which would violate the copyleft restrictions of the GPL This purges as much GPL-covered third-party code as can be identified from git history. It also provides polyfill for some (not *all*) of the discarded infrastructure --- [^1]: https://www.apache.org/licenses/GPL-compatibility.html --- COPYING | 201 ++++++ COPYRIGHT | 29 - LICENSES/GPL-3.0-or-later.txt | 674 ------------------ LICENSES/LicenseRef-CsvQuery.md | 16 - NOTICE.txt | 6 - README.mkd | 5 - REUSE.toml | 7 +- examples/gui/Forms/frmGoToLine.cs | 31 + examples/minimal/Main.cs | 4 +- examples/minimal/PluginOptions.cs | 12 +- lib/Npp.DotNet.Plugin.csproj | 12 +- .../ISettingsManager.cs | 199 ++++++ .../Kbg.NppPluginNET.Contrib/SettingsBase.cs | 192 ----- .../Kbg.NppPluginNET/GatewayDomain.cs | 32 +- .../Kbg.NppPluginNET/ScintillaGateway.cs | 54 +- .../Winforms/Classes/FormBase.cs | 64 +- lib/Npp.DotNet.Plugin/Winforms/FormStyle.cs | 123 ---- lib/Npp.DotNet.Plugin/Winforms/Settings.cs | 20 - .../Winforms/SettingsDialog.cs | 203 ------ lib/{README.mkd => README.md} | 6 +- lib/{README.mkd.license => README.md.license} | 0 21 files changed, 478 insertions(+), 1412 deletions(-) create mode 100644 COPYING delete mode 100644 COPYRIGHT delete mode 100644 LICENSES/GPL-3.0-or-later.txt delete mode 100644 LICENSES/LicenseRef-CsvQuery.md create mode 100644 lib/Npp.DotNet.Plugin/Kbg.NppPluginNET.Contrib/ISettingsManager.cs delete mode 100644 lib/Npp.DotNet.Plugin/Kbg.NppPluginNET.Contrib/SettingsBase.cs delete mode 100644 lib/Npp.DotNet.Plugin/Winforms/FormStyle.cs delete mode 100644 lib/Npp.DotNet.Plugin/Winforms/Settings.cs delete mode 100644 lib/Npp.DotNet.Plugin/Winforms/SettingsDialog.cs rename lib/{README.mkd => README.md} (75%) rename lib/{README.mkd.license => README.md.license} (100%) diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/COPYING @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/COPYRIGHT b/COPYRIGHT deleted file mode 100644 index 1790483..0000000 --- a/COPYRIGHT +++ /dev/null @@ -1,29 +0,0 @@ - - Npp.DotNet.Plugin - - (c) 2016-2024 Kasper B. Graversen, Mark Johnston Olson, Joakim Wennergren, Bas de Reuver, Robert Di Pardo - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - - This software incorporates work covered by the following copyright and permission notice: - - - CsvQuery License - ================== - - - This package as a whole is licensed under the GPL v3. See gpl-3.0.txt - - - The CsharpSqlite code is licensed undet MIT license (as allowed by GPL v3 section 7). See CsharpSqlite\License-CsharpSqlite-MIT.txt diff --git a/LICENSES/GPL-3.0-or-later.txt b/LICENSES/GPL-3.0-or-later.txt deleted file mode 100644 index f288702..0000000 --- a/LICENSES/GPL-3.0-or-later.txt +++ /dev/null @@ -1,674 +0,0 @@ - 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/LICENSES/LicenseRef-CsvQuery.md b/LICENSES/LicenseRef-CsvQuery.md deleted file mode 100644 index d90075d..0000000 --- a/LICENSES/LicenseRef-CsvQuery.md +++ /dev/null @@ -1,16 +0,0 @@ -CsvQuery License -================== - - -This package as a whole is licensed under the GPL v3. See [gpl-3.0.txt] - - -The CsharpSqlite code is licensed undet MIT license (as allowed by GPL v3 section 7). See [CsharpSqlite\License-CsharpSqlite-MIT.txt] - - - - - - -[gpl-3.0.txt]: https://raw.githubusercontent.com/jokedst/CsvQuery/master/CsvQuery/gpl-3.0.txt -[CsharpSqlite\License-CsharpSqlite-MIT.txt]: https://raw.githubusercontent.com/jokedst/CsvQuery/master/CsvQuery/CsharpSqlite/License-CsharpSqlite-MIT.txt diff --git a/NOTICE.txt b/NOTICE.txt index 4fe38ba..1c9024f 100644 --- a/NOTICE.txt +++ b/NOTICE.txt @@ -6,9 +6,3 @@ Npp.DotNet.Plugin includes software developed by: * Mark Johnston Olson https://github.com/molsonkiko/NppCSharpPluginPack - - * Joakim Wennergren - https://github.com/jokedst/CsvQuery - - * Bas de Reuver ("BdR76") - https://github.com/BdR76/CSVLint diff --git a/README.mkd b/README.mkd index 20a4a50..99d93ad 100644 --- a/README.mkd +++ b/README.mkd @@ -89,9 +89,6 @@ For the experimental demo, see [examples/gui/README.mkd]. Except where noted, the source code of Npp.DotNet.Plugin is distributed under the terms of the [Apache License, Version 2.0][apache-2.0]. -The [original source code][csv] of the [Npp.DotNet.Plugin.SettingsBase] class and the [Npp.DotNet.Plugin.Winforms.SettingsDialog] class is -distributed under [additional licensing terms][csv-license]. - This README and all other documentation, including images, are distributed under a [CC0 v1.0 Public Domain Dedication][CC0]. @@ -111,8 +108,6 @@ This README and all other documentation, including images, are distributed under [apache-2.0]: https://raw.githubusercontent.com/npp-dotnet/npp.dotnet.plugin/main/LICENSES/Apache-2.0.txt [CC0]: https://raw.githubusercontent.com/npp-dotnet/npp.dotnet.plugin/main/LICENSES/CC0-1.0.txt -[csv]: https://github.com/jokedst/CsvQuery/blob/master/CsvQuery/PluginInfrastructure/SettingsBase.cs -[csv-license]: LICENSES/LicenseRef-CsvQuery.md [Npp.DotNet.Plugin.SettingsBase]: lib/Npp.DotNet.Plugin/Kbg.NppPluginNET.Contrib/SettingsBase.cs diff --git a/REUSE.toml b/REUSE.toml index 081d5ea..50e0198 100644 --- a/REUSE.toml +++ b/REUSE.toml @@ -7,7 +7,12 @@ SPDX-PackageSupplier = "Robert Di Pardo " SPDX-PackageDownloadLocation = "https://github.com/npp-dotnet/npp.dotnet.plugin.git" [[annotations]] -path = ["**.json", "doc/**", "lib/**.png", "**/CODEOWNERS", "COPYRIGHT", "README**", "NOTICE**"] +path = ["COPYING"] +SPDX-FileCopyrightText = "2004 Apache Software Foundation" +SPDX-License-Identifier = "Apache-2.0" + +[[annotations]] +path = ["**.json", "doc/**", "lib/**.png", "**/CODEOWNERS", "README**", "NOTICE**"] precedence = "aggregate" SPDX-FileCopyrightText = "Public Domain" SPDX-License-Identifier = "CC0-1.0" diff --git a/examples/gui/Forms/frmGoToLine.cs b/examples/gui/Forms/frmGoToLine.cs index 1a51eab..224cde9 100644 --- a/examples/gui/Forms/frmGoToLine.cs +++ b/examples/gui/Forms/frmGoToLine.cs @@ -7,6 +7,7 @@ using Npp.DotNet.Plugin; using Npp.DotNet.Plugin.Winforms.Classes; +using static Npp.DotNet.Plugin.Win32; namespace Kbg.Demo.Namespace { @@ -20,6 +21,36 @@ public frmGoToLine(IScintillaGateway editor) : base(false, true) InitializeComponent(); } + /// + /// Intercepts the default WndProc to prevent an infinite redraw loop when the form undocks. + /// + /// A window notification message structure. + /// See + protected override void WndProc(ref Message wmNotifyMsg) + { + switch (wmNotifyMsg.Msg) + { + case WM_NOTIFY: + TagNMHDR nmdr = (TagNMHDR)wmNotifyMsg.GetLParam(typeof(TagNMHDR))!; + + if (nmdr.hwndFrom == PluginData.NppData.NppHandle) + { + switch ((DockMgrMsg)(nmdr.code & 0xFFFFU)) + { + case DockMgrMsg.DMN_DOCK: + break; + case DockMgrMsg.DMN_FLOAT: + RemoveControlParent(); + break; + case DockMgrMsg.DMN_CLOSE: + break; + } + } + break; + } + base.WndProc(ref wmNotifyMsg); + } + private void button1_Click(object sender, EventArgs e) { int line; diff --git a/examples/minimal/Main.cs b/examples/minimal/Main.cs index 6e84fe1..e33b235 100644 --- a/examples/minimal/Main.cs +++ b/examples/minimal/Main.cs @@ -128,13 +128,13 @@ static void DisplayInfo() /// /// Open the plugin's INI file in Notepad++. /// - static void OpenConfigFile() => Config?.Open(); + static void OpenConfigFile() => Config?.OpenFile(); #endregion /// should be a singleton class private Main() { } private static readonly Main Instance; private static readonly PluginOptions Config; - private static readonly string PluginName = ".NET Demo Plugin\0"; + public static readonly string PluginName = ".NET Demo Plugin\0"; } } diff --git a/examples/minimal/PluginOptions.cs b/examples/minimal/PluginOptions.cs index 893300e..8461544 100644 --- a/examples/minimal/PluginOptions.cs +++ b/examples/minimal/PluginOptions.cs @@ -7,14 +7,14 @@ namespace Npp.DotNet.Plugin.Demo { - class PluginOptions : SettingsBase + class PluginOptions : DefaultSettings { #region "Examples of possible plugin options" [Description("A sample text property (en-US)"), Category("Strings")] public string DefaultMessage { get; set; } = "Hello, World!"; [Description("A sample text property (ja-JP)"), Category("Strings")] - public string LocalizedMessage { get; set; } = "こにちは、皆さん‼"; + public string LocalizedMessage { get; set; } = "こんにちは、皆さん‼"; [Description("A sample enum property"), Category("Enum")] public ConsoleColor Color { get; set; } = ConsoleColor.Green; @@ -33,7 +33,7 @@ public string FilePath { get { - var folderName = _pluginName.Trim(new char[] { '\0', ' ' }); + var folderName = Main.PluginName.Trim(new char[] { '\0', ' ' }); var configDir = new DirectoryInfo(Path.Combine(NppUtils.ConfigDirectory, folderName)); if (!configDir.Exists) configDir = Directory.CreateDirectory(Path.Combine(NppUtils.ConfigDirectory, folderName)); @@ -41,8 +41,8 @@ public string FilePath } } - public void Load() => ReadFromIniFile(FilePath); - public void Save() => SaveToIniFile(FilePath); - public void Open() => OpenFile(FilePath); + public void Load() => base.Load(FilePath); + public void Save() => base.Save(FilePath); + public override void OpenFile() => NppUtils.Notepad.OpenFile(FilePath); } } diff --git a/lib/Npp.DotNet.Plugin.csproj b/lib/Npp.DotNet.Plugin.csproj index 521ea57..74712ca 100644 --- a/lib/Npp.DotNet.Plugin.csproj +++ b/lib/Npp.DotNet.Plugin.csproj @@ -3,9 +3,10 @@ 0.0.1.0 alpha - Kasper B. Graversen, Mark Johnston Olson, Joakim Wennergren, Bas de Reuver, Robert Di Pardo + Kasper B. Graversen, Mark Johnston Olson, Robert Di Pardo (c) 2016-2024 Kasper B. Graversen and Contributors AOT-ready port of the .NET Framework plugin template for Notepad++ + README.md brand.png https://github.com/npp-dotnet https://github.com/npp-dotnet/npp.dotnet.plugin @@ -31,9 +32,6 @@ embedded - - - Npp.DotNet.Plugin.snk true true @@ -41,10 +39,10 @@ - + - - + + diff --git a/lib/Npp.DotNet.Plugin/Kbg.NppPluginNET.Contrib/ISettingsManager.cs b/lib/Npp.DotNet.Plugin/Kbg.NppPluginNET.Contrib/ISettingsManager.cs new file mode 100644 index 0000000..5dccbfc --- /dev/null +++ b/lib/Npp.DotNet.Plugin/Kbg.NppPluginNET.Contrib/ISettingsManager.cs @@ -0,0 +1,199 @@ +/* + * SPDX-FileCopyrightText: 2024 Robert Di Pardo + * + * SPDX-License-Identifier: Apache-2.0 + */ +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.IO; +using System.Linq; +using System.Reflection; +using System.Text; + +#if NET7_0_OR_GREATER +using System.Diagnostics.CodeAnalysis; +#endif + +namespace Npp.DotNet.Plugin +{ + /// + /// Provides plugins with methods to read and write INI configuration files. + /// + public interface ISettingsManager + { + void Load(string filePath = null); + void Save(string filePath = null); + void OpenFile(); + } + + /// + /// Default implementation of the interface. + /// +#if NET7_0_OR_GREATER + // https://learn.microsoft.com/dotnet/core/deploying/trimming/fixing-warnings#functionality-with-requirements-on-its-input + [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicProperties)] +#endif + public class DefaultSettings : ISettingsManager + { + /// + /// Token used to separate property keys from values. + /// + public char KeyValueSeparator = '='; + + /// + /// Sets all writable properties of this from the values in the INI file at . + /// + /// Full file path of an INI file. + public virtual void Load(string filePath = null) + { + if (string.IsNullOrEmpty(filePath) || !File.Exists(filePath)) + return; + + var keyValuePairs = new Dictionary(); + foreach (string line in File.ReadAllLines(filePath)) + { + try + { + if (line.Contains(KeyValueSeparator)) + { + var kv = line.Split(new char[] { KeyValueSeparator }, StringSplitOptions.RemoveEmptyEntries); + if (kv.Length > 1) + keyValuePairs.Add(kv.First()?.Trim(), string.Join("", kv.Skip(1)).Trim()); + } + } + catch (Exception e) + { + _ = Win32.MsgBoxDialog( + IntPtr.Zero, + $"Parsing \"{line}\" failed with message:\r\n\r\n{e.Message}\0", + $"{e.GetType().Name}\0", + (uint)Win32.MsgBox.ICONERROR); + } + } + + foreach (var keyValueStr in keyValuePairs) + { + string key = keyValueStr.Key; + string valueStr = keyValueStr.Value; + + try + { + var propInfo = GetType().GetProperties().FirstOrDefault(p => p.CanWrite && p.Name == key); + if (propInfo is null) + continue; + + if (propInfo.PropertyType.IsEnum) + propInfo.SetValue(this, ParseEnumProperty(propInfo.PropertyType, valueStr), null); + else if (int.TryParse(valueStr, out int intVal)) + { + // Parse 0 as false, !0 as true + if (propInfo.PropertyType == typeof(bool)) + propInfo.SetValue(this, intVal != 0, null); + else + propInfo.SetValue(this, intVal, null); + } + else if (double.TryParse(valueStr, out double dblVal)) + propInfo.SetValue(this, dblVal, null); + else if (bool.TryParse(valueStr, out bool boolVal)) + propInfo.SetValue(this, boolVal, null); + else + propInfo.SetValue(this, valueStr, null); + + } + catch (Exception e) + { + _ = Win32.MsgBoxDialog( + IntPtr.Zero, + $"Setting property {key}{KeyValueSeparator}\"{valueStr}\" failed with message:\r\n\r\n{e.Message}\0", + $"{e.GetType().Name}\0", + (uint)Win32.MsgBox.ICONERROR); + } + } + + } + + /// + /// Dumps all writable properties of this to the INI file at . + /// + /// Full file path of an INI file. + public virtual void Save(string filePath = null) + { + if (string.IsNullOrEmpty(filePath) || GetType().GetProperties().Length < 1) + return; + + try + { + var iniText = new StringBuilder(); + var props = + GetType().GetProperties().Where(p => p.CanWrite) + .GroupBy(p => p.GetCustomAttribute() ?? new CategoryAttribute("Misc")); + foreach (var section in props.Select(s => s.Key).Distinct()) + { + iniText.AppendLine($"[{section.Category}]"); + foreach (var propGrp in props.Where(g => g.Key.Category == section.Category)) + { + foreach (var propInfo in propGrp) + { + if (!(propInfo.GetCustomAttribute() is null)) + iniText.AppendLine($"; {propInfo.GetCustomAttribute().Description}"); + + var propValue = propInfo.PropertyType.IsEnum + ? ParseEnumProperty(propInfo.PropertyType, $"{propInfo.GetValue(this, null)}") + : propInfo.GetValue(this, null); + + iniText.AppendLine($"{propInfo.Name}{KeyValueSeparator}{propValue}"); + } + } + iniText.AppendLine(); + } + + File.WriteAllText(filePath, iniText.ToString()); + } + catch (Exception e) + { + _ = Win32.MsgBoxDialog( + IntPtr.Zero, + $"Saving properties failed with message:\r\n\r\n{e.StackTrace}\0", + $"{e.GetType().Name}\0", + (uint)Win32.MsgBox.ICONERROR); + } + } + + /// + /// Opens the INI file of this . + /// + /// Deriving classes must implement this method for themselves. + public virtual void OpenFile() { } + + /// + /// Parses a named enum value, ignoring case, or the underlying numeric value. + /// + /// Some enum type. + /// A name defined by , or a number. + /// + /// For example, if is , the result is when + /// is "Ok" or "0". + /// + /// + /// Thrown if is not a value of . + /// + protected static object ParseEnumProperty(Type TEnum, string propertyStr) + { + string valueStr = +#if NETCOREAPP + Enum.TryParse(TEnum, propertyStr, true, out object _) + ? propertyStr + : uint.TryParse(propertyStr, out uint intVal) && Enum.TryParse(TEnum, $"{intVal}", false, out _) +#else // .NET Framework + (Enum.GetNames(TEnum)?.Any(n => string.Compare(n, propertyStr, StringComparison.OrdinalIgnoreCase) == 0)).GetValueOrDefault(false) + ? propertyStr + : uint.TryParse(propertyStr, out uint intVal) +#endif + ? $"{intVal}" + : throw new ArgumentException($"Invalid value \"{propertyStr}\" for enum {TEnum.FullName}"); + + return Enum.Parse(TEnum, valueStr, true); + } + } +} diff --git a/lib/Npp.DotNet.Plugin/Kbg.NppPluginNET.Contrib/SettingsBase.cs b/lib/Npp.DotNet.Plugin/Kbg.NppPluginNET.Contrib/SettingsBase.cs deleted file mode 100644 index d4fea0d..0000000 --- a/lib/Npp.DotNet.Plugin/Kbg.NppPluginNET.Contrib/SettingsBase.cs +++ /dev/null @@ -1,192 +0,0 @@ -/* - * SPDX-FileCopyrightText: 2024 Mark Johnston Olson - * 2017-2020 Joakim Wennergren - * 2020-2024 Bas de Reuver ("BdR76") - * SPDX-License-Identifier: Apache-2.0 OR LicenseRef-CsvQuery OR GPL-3.0-or-later - */ - -using System; -using System.Collections.Generic; -using System.ComponentModel; -using System.Linq; -using System.IO; -using System.Runtime.InteropServices; -using System.Text; - -namespace Npp.DotNet.Plugin -{ - /// - /// Utilities for storing, viewing, and updating the settings of the plugin.
- /// Extracted from CSVLint. - /// -#if NET7_0_OR_GREATER - // https://learn.microsoft.com/dotnet/core/deploying/trimming/fixing-warnings#functionality-with-requirements-on-its-input - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] -#endif - public class SettingsBase - { - protected readonly INotepadPPGateway _npp; - protected string _iniFilePath; - protected string _pluginName; - - public SettingsBase() - { - _pluginName = Marshal.PtrToStringUni(PluginData.PszPluginName) ?? PluginData.DefaultPluginName; - _npp = new NotepadPPGateway(); - _iniFilePath = Path.Combine(_npp.GetPluginConfigPath(), $"{_pluginName}.ini"); - } - - /// - /// By default loads settings from the default N++ config folder - /// - /// If false will not load anything and have default values set - public SettingsBase(bool loadFromFile = true) : this() - { - // Set defaults - foreach (var propertyInfo in GetType().GetProperties()) - { - if (propertyInfo.GetCustomAttributes(typeof(DefaultValueAttribute), false).FirstOrDefault() is DefaultValueAttribute def) - { - propertyInfo.SetValue(this, def.Value, null); - } - } - if (loadFromFile) - ReadFromIniFile(); - } - - /// - /// Reads all (existing) settings from an ini-file - /// - /// File to write to (default is N++ plugin config) - public void ReadFromIniFile(string filename = null) - { - filename = filename ?? _iniFilePath; - if (!File.Exists(filename)) return; - - // Load all sections from file - var loaded = GetType().GetProperties() - .Select(x => ((CategoryAttribute)x.GetCustomAttributes(typeof(CategoryAttribute), false).FirstOrDefault())?.Category ?? "General") - .Distinct() - .ToDictionary(section => section, section => GetKeys(filename, section)); - - foreach (var propertyInfo in GetType().GetProperties().Where(x => x.CanWrite)) - { - var category = ((CategoryAttribute)propertyInfo.GetCustomAttributes(typeof(CategoryAttribute), false).FirstOrDefault())?.Category ?? "General"; - var name = propertyInfo.Name; - if (loaded.TryGetValue(category, out Dictionary value) && value.TryGetValue(name, out string rawString) && !string.IsNullOrEmpty(rawString)) - { - try - { - if (propertyInfo.PropertyType.IsEnum) - propertyInfo.SetValue(this, ParseEnumProperty(propertyInfo.PropertyType, rawString), null); - else if (int.TryParse(rawString, out int intVal)) - { - // Parse 0 as false, !0 as true - if (propertyInfo.PropertyType == typeof(bool)) - propertyInfo.SetValue(this, intVal != 0, null); - else - propertyInfo.SetValue(this, intVal, null); - } - else if (double.TryParse(rawString, out double dblVal)) - propertyInfo.SetValue(this, dblVal, null); - else if (bool.TryParse(rawString, out bool boolVal)) - propertyInfo.SetValue(this, boolVal, null); - else - propertyInfo.SetValue(this, rawString, null); - } - catch (Exception e) - { - _ = Win32.MsgBoxDialog( - IntPtr.Zero, - $"Setting property {propertyInfo.Name}=\"{rawString}\" failed with message:\r\n\r\n{e.Message}\0", - $"{e.GetType().Name}\0", - (uint)Win32.MsgBox.ICONERROR); - } - } - } - } - - /// - /// Saves all settings to an ini-file, under "General" section - /// - /// File to write to (default is N++ plugin config) - public void SaveToIniFile(string filename = null) - { - filename = filename ?? _iniFilePath; - NppUtils.CreateConfigSubDirectoryIfNotExists(); - - // Win32.WritePrivateProfileSection (that NppPlugin uses) doesn't work well with non-ASCII characters. So we roll our own. - using (var fp = new StreamWriter(filename, false, Encoding.UTF8)) - { - fp.WriteLine("; {0} settings file", _pluginName); - - foreach (var section in GetType() - .GetProperties() - .GroupBy(x => ((CategoryAttribute)x.GetCustomAttributes(typeof(CategoryAttribute), false).FirstOrDefault())?.Category ?? "General")) - { - fp.WriteLine(Environment.NewLine + "[{0}]", section.Key); - foreach (var propertyInfo in section.Where(x => x.CanWrite).OrderBy(x => x.Name)) - { - if (propertyInfo.GetCustomAttributes(typeof(DescriptionAttribute), false).FirstOrDefault() is DescriptionAttribute description) - fp.WriteLine("; " + description.Description.Replace(Environment.NewLine, Environment.NewLine + "; ")); - fp.WriteLine("{0}={1}", propertyInfo.Name, propertyInfo.GetValue(this, null)); - } - } - } - } - - /// - /// Parses a named enum value, ignoring case, or the underlying numeric value. - /// - /// Some enum type. - /// A name defined by , or a number. - /// - /// For example, if is , the result is when - /// is "Ok" or "0". - /// - /// - /// Thrown if is not a value of . - /// - private static object ParseEnumProperty(Type TEnum, string propertyStr) - { - string valueStr = -#if NETCOREAPP - Enum.TryParse(TEnum, propertyStr, true, out object _) - ? propertyStr - : uint.TryParse(propertyStr, out uint intVal) && Enum.TryParse(TEnum, $"{intVal}", false, out _) -#else // .NET Framework - (Enum.GetNames(TEnum)?.Any(n => string.Compare(n, propertyStr, StringComparison.OrdinalIgnoreCase) == 0)).GetValueOrDefault(false) - ? propertyStr - : uint.TryParse(propertyStr, out uint intVal) -#endif - ? $"{intVal}" - : throw new ArgumentException($"Invalid value \"{propertyStr}\" for enum {TEnum.FullName}"); - - return Enum.Parse(TEnum, valueStr, true); - } - - /// - /// Read a section from an ini-file - /// - /// Path to ini-file - /// Section to read - protected Dictionary GetKeys(string iniFile, string category) - { - var buffer = new byte[8 * 1024]; - - _ = Win32.GetPrivateProfileSection(category, buffer, buffer.Length, iniFile); - var tmp = Encoding.UTF8.GetString(buffer).Trim('\0').Split('\0'); - return tmp.Select(x => x.Split(new[] { '=' }, 2)) - .Where(x => x.Length == 2) - .ToDictionary(x => x[0], x => x[1]); - } - - /// Opens the config file directly in Notepad++ - public void OpenFile(string filename = null) - { - var path = filename ?? _iniFilePath; - if (!File.Exists(path)) SaveToIniFile(path); - Win32.SendMessage(PluginData.NppData.NppHandle, (uint)NppMsg.NPPM_DOOPEN, 0U, path); - } - } -} diff --git a/lib/Npp.DotNet.Plugin/Kbg.NppPluginNET/GatewayDomain.cs b/lib/Npp.DotNet.Plugin/Kbg.NppPluginNET/GatewayDomain.cs index 4031e25..0f6a964 100644 --- a/lib/Npp.DotNet.Plugin/Kbg.NppPluginNET/GatewayDomain.cs +++ b/lib/Npp.DotNet.Plugin/Kbg.NppPluginNET/GatewayDomain.cs @@ -1,8 +1,7 @@ /* * SPDX-FileCopyrightText: 2016 Kasper B. Graversen - * 2023 Bas de Reuver ("BdR76") * - * SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later + * SPDX-License-Identifier: Apache-2.0 */ using System; @@ -50,35 +49,6 @@ public int Value } } - /// - /// Colours are set using the RGB format (Red, Green, Blue). The intensity of each colour is set in the range 0 to 255. - /// If you have three such intensities, they are combined as: red | (green << 8) | (blue << 16). - /// If you set all intensities to 255, the colour is white. If you set all intensities to 0, the colour is black. - /// When you set a colour, you are making a request. What you will get depends on the capabilities of the system and the current screen mode. - /// - public class ColourAlpha - { - public readonly int Red, Green, Blue, Alpha; - - public ColourAlpha(Int64 rgba) - { - Red = (byte)rgba & 0xFF; - Green = (byte)(rgba >> 8) & 0xFF; - Blue = (byte)(rgba >> 16) & 0xFF; - Alpha = (byte)(rgba >> 24) & 0xFF; - } - - public ColourAlpha(byte red, byte green, byte blue, byte alpha) - { - Red = red; - Green = green; - Blue = blue; - Alpha = alpha; - } - - public int Value => Red + (Green << 8) + (Blue << 16) + (Alpha << 24); - } - /// /// Positions within the Scintilla document refer to a character or the gap before that character. /// The first character in a document is 0, the second 1 and so on. If a document contains nLen characters, the last character is numbered nLen-1. The caret exists between character positions and can be located from before the first character (0) to after the last character (nLen). diff --git a/lib/Npp.DotNet.Plugin/Kbg.NppPluginNET/ScintillaGateway.cs b/lib/Npp.DotNet.Plugin/Kbg.NppPluginNET/ScintillaGateway.cs index 1b13baf..e33bb56 100644 --- a/lib/Npp.DotNet.Plugin/Kbg.NppPluginNET/ScintillaGateway.cs +++ b/lib/Npp.DotNet.Plugin/Kbg.NppPluginNET/ScintillaGateway.cs @@ -1,8 +1,7 @@ /* * SPDX-FileCopyrightText: 2016 Kasper B. Graversen - * 2023 Bas de Reuver ("BdR76") * - * SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later + * SPDX-License-Identifier: Apache-2.0 */ using System; @@ -830,57 +829,6 @@ public void StyleSetCharacterSet(int style, CharacterSet characterSet) SendMessage(_scintilla, SciMsg.SCI_STYLESETCHARACTERSET, (UIntPtr)style, (IntPtr)characterSet); } - /// - /// Set the colour of an element. Translucency (alpha) may or may not be significant - /// and this may depend on the platform. The alpha byte should commonly be 0xff for opaque. - /// (Scintilla feature 2753) - /// - /// SC_ELEMENT_* code. See - /// A translucent colour. - public void SetElementColour(uint element, ColourAlpha colourElement) - { - Win32.SendMessage(_scintilla, SciMsg.SCI_SETELEMENTCOLOUR, element, colourElement.Value); - } - - /// Get the colour of an element. (Scintilla feature 2754) - /// SC_ELEMENT_* code. See - public ColourAlpha GetElementColour(uint element) - { - return new ColourAlpha((int)Win32.SendMessage(_scintilla, SciMsg.SCI_GETELEMENTCOLOUR, element, Unused)); - } - - /// Use the default or platform-defined colour for an element. (Scintilla feature 2755) - /// SC_ELEMENT_* code. See - public void ResetElementColour(uint element) - { - Win32.SendMessage(_scintilla, SciMsg.SCI_RESETELEMENTCOLOUR, element, Unused); - } - - /// - /// Get whether an element has been set by SetElementColour. - /// When false, a platform-defined or default colour is used. - /// (Scintilla feature 2756) - /// - /// SC_ELEMENT_* code. See - public bool GetElementIsSet(uint element) - { - return 1 == (int)Win32.SendMessage(_scintilla, SciMsg.SCI_GETELEMENTISSET, element, Unused); - } - - /// Get whether an element supports translucency. (Scintilla feature 2757) - /// SC_ELEMENT_* code. See - public bool GetElementAllowsTranslucent(uint element) - { - return 1 == (int)Win32.SendMessage(_scintilla, SciMsg.SCI_GETELEMENTALLOWSTRANSLUCENT, element, Unused); - } - - /// Get the colour of an element. (Scintilla feature 2758) - /// SC_ELEMENT_* code. See - public ColourAlpha GetElementBaseColour(uint element) - { - return new ColourAlpha((int)Win32.SendMessage(_scintilla, SciMsg.SCI_GETELEMENTBASECOLOUR, element, Unused)); - } - /// Set a style to be a hotspot or not. (Scintilla feature 2409) public void StyleSetHotSpot(int style, bool hotspot) { diff --git a/lib/Npp.DotNet.Plugin/Winforms/Classes/FormBase.cs b/lib/Npp.DotNet.Plugin/Winforms/Classes/FormBase.cs index 63f16cd..ba2ce43 100644 --- a/lib/Npp.DotNet.Plugin/Winforms/Classes/FormBase.cs +++ b/lib/Npp.DotNet.Plugin/Winforms/Classes/FormBase.cs @@ -30,8 +30,8 @@ public partial class FormBase : Form /// private bool IsLoaded { get; set; } - private static WindowLongGetter _wndLongGetter = GetWindowLongPtr; - private static WindowLongSetter _wndLongSetter = SetWindowLongPtr; + private static WindowLongGetter WndLongGetter { get; set; } = GetWindowLongPtr; + private static WindowLongSetter WndLongSetter { get; set; } = SetWindowLongPtr; /// /// superclass of all forms in the application.

@@ -45,13 +45,10 @@ public FormBase(bool isModal, bool isDocking) IsModal = isModal; IsDocking = isDocking; Callbacks.RegisterFormIfModeless(this, isModal); - if (IsDocking) + if (!Environment.Is64BitProcess) { - if (!Environment.Is64BitProcess) // we are 32-bit - { - _wndLongGetter = GetWindowLong; - _wndLongSetter = SetWindowLong; - } + WndLongGetter = GetWindowLong; + WndLongSetter = SetWindowLong; } } @@ -111,53 +108,38 @@ protected override bool ProcessDialogKey(Keys keyData) return base.ProcessDialogKey(keyData); } - /// - /// this fixes a bug where Notepad++ can hang in the following situation:

- /// 1. you are in a docking form

- /// 2. you click a button that is a child of another control (e.g., a GroupBox)

- /// 3. that button would cause a new form to appear

- /// see https://github.com/BdR76/CSVLint/pull/88/commits - /// - protected override void WndProc(ref Message m) + protected void AddControlParent() { - if (IsDocking) + if (this.HasChildren) { - switch (m.Msg) + long extAttrs = (long)WndLongGetter(this.Handle, GWL_EXSTYLE); + if (WS_EX_CONTROLPARENT != (extAttrs & WS_EX_CONTROLPARENT)) { - case WM_NOTIFY: - var nmdr = (TagNMHDR)m.GetLParam(typeof(TagNMHDR)); - - if (nmdr.hwndFrom == PluginData.NppData.NppHandle) - { - switch ((DockMgrMsg)(nmdr.code & 0xFFFFU)) - { - case DockMgrMsg.DMN_DOCK: // we are being docked - break; - case DockMgrMsg.DMN_FLOAT: // we are being _un_docked - RemoveControlParent(this); - break; - case DockMgrMsg.DMN_CLOSE: // we are being closed - break; - } - } - break; + SetControlParent(this, extAttrs | WS_EX_CONTROLPARENT); } } - base.WndProc(ref m); } - private void RemoveControlParent(Control parent) + protected void RemoveControlParent() { - if (parent.HasChildren) + if (this.HasChildren) { - long extAttrs = (long)_wndLongGetter(parent.Handle, GWL_EXSTYLE); + long extAttrs = (long)WndLongGetter(this.Handle, GWL_EXSTYLE); if (WS_EX_CONTROLPARENT == (extAttrs & WS_EX_CONTROLPARENT)) { - _wndLongSetter(parent.Handle, GWL_EXSTYLE, new IntPtr(extAttrs & ~WS_EX_CONTROLPARENT)); + SetControlParent(this, extAttrs & ~WS_EX_CONTROLPARENT); } + } + } + + private static void SetControlParent(Control parent, long wsExMask) + { + if (parent.HasChildren) + { + WndLongSetter(parent.Handle, GWL_EXSTYLE, new IntPtr(wsExMask)); foreach (Control c in parent.Controls) { - RemoveControlParent(c); + SetControlParent(c, wsExMask); } } } diff --git a/lib/Npp.DotNet.Plugin/Winforms/FormStyle.cs b/lib/Npp.DotNet.Plugin/Winforms/FormStyle.cs deleted file mode 100644 index a0edc6d..0000000 --- a/lib/Npp.DotNet.Plugin/Winforms/FormStyle.cs +++ /dev/null @@ -1,123 +0,0 @@ -/* - * SPDX-FileCopyrightText: 2024 Mark Johnston Olson - * - * SPDX-License-Identifier: Apache-2.0 - */ - -using System.Drawing; -using System.Windows.Forms; - -namespace Npp.DotNet.Plugin.Winforms -{ - public static class FormStyle - { - public static readonly Color SlightlyDarkControl = Color.FromArgb( - 3 * SystemColors.Control.R / 4 + SystemColors.ControlDark.R / 4, - 3 * SystemColors.Control.G / 4 + SystemColors.ControlDark.G / 4, - 3 * SystemColors.Control.B / 4 + SystemColors.ControlDark.B / 4 - ); - - /// - /// Changes the background and text color of the form - /// and any child forms to match the editor window.

- /// Fires when the form is first opened - /// and also whenever the style is changed.

- /// Heavily based on CsvQuery (https://github.com/jokedst/CsvQuery) - /// - public static void ApplyStyle(Control ctrl, bool useNppStyle, bool darkMode = false) - { - if (ctrl == null || ctrl.IsDisposed) return; - if (!NppUtils.NppVersionAtLeast8) - useNppStyle = false; // trying to follow editor style looks weird for Notepad++ 7.3.3 - if (ctrl is Form form) - { - foreach (Form childForm in form.OwnedForms) - { - ApplyStyle(childForm, useNppStyle, darkMode); - } - } - Color backColor = DialogUtils.NotepadGUI.GetDefaultBackgroundColor(); - if (!useNppStyle || ( - backColor.R > 240 && - backColor.G > 240 && - backColor.B > 240)) - { - // if the background is basically white, - // use the system defaults because they - // look best on a white or nearly white background - ctrl.BackColor = SystemColors.Control; - ctrl.ForeColor = SystemColors.ControlText; - foreach (Control child in ctrl.Controls) - { - if (child.HasChildren && !(child is Form)) - // recursively apply style to children of container controls (GroupBoxes, SplitContainers, etc.) - ApplyStyle(child, useNppStyle, darkMode); - // controls containing text - if (child is TextBox || child is ListBox || child is ComboBox || child is TreeView) - { - child.BackColor = SystemColors.Window; // white background - child.ForeColor = SystemColors.WindowText; - } - else if (child is DataGridView dgv) - { - dgv.EnableHeadersVisualStyles = true; - dgv.BackgroundColor = SystemColors.ControlDark; - dgv.ForeColor = SystemColors.ControlText; - dgv.GridColor = SystemColors.ControlLight; - dgv.RowsDefaultCellStyle.ForeColor = SystemColors.ControlText; - dgv.RowsDefaultCellStyle.BackColor = SystemColors.Window; - } - else - { - // buttons should be a bit darker but everything else is the same color as the background - child.BackColor = (child is Button) ? SlightlyDarkControl : SystemColors.Control; - child.ForeColor = SystemColors.ControlText; - if (child is LinkLabel llbl) - { - llbl.LinkColor = Color.Blue; - llbl.ActiveLinkColor = Color.Red; - llbl.VisitedLinkColor = Color.Purple; - } - } - } - return; - } - - Color foreColor = DialogUtils.NotepadGUI.GetDefaultForegroundColor(); - ctrl.BackColor = backColor; - Color InBetween = Color.FromArgb( - foreColor.R / 4 + 3 * backColor.R / 4, - foreColor.G / 4 + 3 * backColor.G / 4, - foreColor.B / 4 + 3 * backColor.B / 4 - ); - - foreach (Control child in ctrl.Controls) - { - child.BackColor = backColor; - child.ForeColor = foreColor; - if (child.HasChildren && !(child is Form)) - // recursively apply style to children of container controls (GroupBoxes, SplitContainers, etc.) - ApplyStyle(child, useNppStyle, darkMode); - if (child is LinkLabel llbl) - { - llbl.LinkColor = foreColor; - llbl.ActiveLinkColor = foreColor; - llbl.VisitedLinkColor = foreColor; - } - else if (child is DataGridView dgv) - { - dgv.EnableHeadersVisualStyles = false; - dgv.BackgroundColor = InBetween; - dgv.ForeColor = foreColor; - dgv.GridColor = foreColor; - dgv.ColumnHeadersDefaultCellStyle.ForeColor = foreColor; - dgv.ColumnHeadersDefaultCellStyle.BackColor = backColor; - dgv.RowHeadersDefaultCellStyle.ForeColor = foreColor; - dgv.RowHeadersDefaultCellStyle.BackColor = backColor; - dgv.RowsDefaultCellStyle.ForeColor = foreColor; - dgv.RowsDefaultCellStyle.BackColor = backColor; - } - } - } - } -} diff --git a/lib/Npp.DotNet.Plugin/Winforms/Settings.cs b/lib/Npp.DotNet.Plugin/Winforms/Settings.cs deleted file mode 100644 index 22df54d..0000000 --- a/lib/Npp.DotNet.Plugin/Winforms/Settings.cs +++ /dev/null @@ -1,20 +0,0 @@ -/* - * SPDX-FileCopyrightText: 2024 Mark Johnston Olson - * - * SPDX-License-Identifier: Apache-2.0 - */ - -namespace Npp.DotNet.Plugin.Winforms -{ - /// - /// Manages application settings - /// - public class Settings : SettingsDialog - { - /// - public override void ChangeMenuItemState(FuncItem itemToCheck) - { - base.ChangeMenuItemState(itemToCheck); - } - } -} diff --git a/lib/Npp.DotNet.Plugin/Winforms/SettingsDialog.cs b/lib/Npp.DotNet.Plugin/Winforms/SettingsDialog.cs deleted file mode 100644 index 422377d..0000000 --- a/lib/Npp.DotNet.Plugin/Winforms/SettingsDialog.cs +++ /dev/null @@ -1,203 +0,0 @@ -/* - * SPDX-FileCopyrightText: 2024 Mark Johnston Olson - * 2017-2020 Joakim Wennergren - * - * SPDX-License-Identifier: Apache-2.0 OR LicenseRef-CsvQuery - */ - -using System; -using System.Collections.Generic; -using System.ComponentModel; -using System.Drawing; -using System.Diagnostics; -using System.Linq; -using System.Windows.Forms; - -namespace Npp.DotNet.Plugin.Winforms -{ - /// - /// Extends with forms for modifying plugin settings. - /// - public class SettingsDialog : SettingsBase - { - private const int DEFAULT_WIDTH = 430; - private const int DEFAULT_HEIGHT = 300; - - /// Delegate for update events - public delegate void RepositoryEventHandler(object sender, SettingsChangedEventArgs e); - - /// Raised before settings has been changed, allowing listeners to cancel the change - public event RepositoryEventHandler ValidateChanges; - - /// Raised after a setting has been changed - public event RepositoryEventHandler SettingsChanged; - - /// Overridable event logic - protected virtual void OnSettingsChanged(object sender, SettingsChangedEventArgs e) - { - SettingsChanged?.Invoke(sender, e); - } - - /// Overridable event logic - protected virtual bool OnValidateChanges(object sender, SettingsChangedEventArgs e) - { - ValidateChanges?.Invoke(sender, e); - return !e.Cancel; - } - - /// - /// things to do whenever the settings are changed by using the dialog

- /// The main thing to always do is save settings to the {PluginName}.ini file.

- /// override this in your Settings.cs as desired, - /// but make sure to call base.OnSettingsChanged() in the override. - /// - public void OnSettingsChanged() - { - SaveToIniFile(); - } - - /// - /// Register the changed state of a plugin menu item. Overridable. - /// - /// menu item that has changed state - public virtual void ChangeMenuItemState(FuncItem itemToCheck) - { - OnSettingsChanged(); - // (un)check the menu item - Utils.CheckMenuItem(itemToCheck.CmdID, !Convert.ToBoolean(itemToCheck.Init2Check)); - } - - /// - /// Opens a window that edits all settings - /// - public void ShowDialog(bool debug = false) - { - // We bind a copy of this object and only apply it after they click "Ok" - var copy = (Settings)MemberwiseClone(); -#if DEBUG - // check the current settings - var settings_sb = new System.Text.StringBuilder(); - foreach (System.Reflection.PropertyInfo p in GetType().GetProperties()) - { - settings_sb.Append(p.ToString()); - settings_sb.Append($": {p.GetValue(this)}"); - settings_sb.Append(", "); - } - MessageBox.Show(settings_sb.ToString()); -#endif - var dialog = new Form() - { - Text = $"Settings - {_pluginName} plug-in", - ClientSize = new Size(DEFAULT_WIDTH, DEFAULT_HEIGHT), - MinimumSize = new Size(250, 250), - ShowIcon = false, - AutoScaleMode = AutoScaleMode.Font, - AutoScaleDimensions = new SizeF(6F, 13F), - ShowInTaskbar = false, - StartPosition = FormStartPosition.CenterParent, - Controls = - { - new Button - { - Name = "Cancel", - Text = "&Cancel", - Anchor = AnchorStyles.Bottom | AnchorStyles.Right, - Size = new Size(75, 23), - Location = new Point(DEFAULT_WIDTH - 115, DEFAULT_HEIGHT - 36), - UseVisualStyleBackColor = true - }, - new Button - { - Name = "Reset", - Text = "&Reset", - Anchor = AnchorStyles.Bottom | AnchorStyles.Right, - Size = new Size(75, 23), - Location = new Point(DEFAULT_WIDTH - 212, DEFAULT_HEIGHT - 36), - UseVisualStyleBackColor = true - }, - new Button - { - Name = "Ok", - Text = "&Ok", - Anchor = AnchorStyles.Bottom | AnchorStyles.Right, - Size = new Size(75, 23), - Location = new Point(DEFAULT_WIDTH - 310, DEFAULT_HEIGHT - 36), - UseVisualStyleBackColor = true - }, - new PropertyGrid - { - Name = "Grid", - Anchor = AnchorStyles.Top | AnchorStyles.Bottom | AnchorStyles.Left | AnchorStyles.Right, - Location = new Point(13, 13), - Size = new Size(DEFAULT_WIDTH - 13 - 13, DEFAULT_HEIGHT - 55), - AutoScaleMode = AutoScaleMode.Font, - AutoScaleDimensions = new SizeF(6F,13F), - SelectedObject = copy - }, - } - }; - - dialog.Controls["Cancel"].Click += (a, b) => dialog.Close(); - dialog.Controls["Ok"].Click += (a, b) => - { - // change the settings to whatever the user selected - var changesEventArgs = new SettingsChangedEventArgs((Settings)this, copy); - if (!changesEventArgs.Changed.Any()) - { - dialog?.Close(); - return; - } - foreach (var propertyInfo in GetType().GetProperties()) - { - var oldValue = propertyInfo.GetValue(this, null); - var newValue = propertyInfo.GetValue(copy, null); - if (oldValue != null && !oldValue.Equals(newValue)) - propertyInfo.SetValue(this, newValue, null); - } - OnSettingsChanged(); - dialog.Close(); - }; - - dialog.Controls["Reset"].Click += (a, b) => - { - // reset the settings to defaults - foreach (var propertyInfo in GetType().GetProperties()) - { - if (propertyInfo.GetCustomAttributes(typeof(DefaultValueAttribute), false).FirstOrDefault() is DefaultValueAttribute def) - { - propertyInfo.SetValue(this, def.Value, null); - } - } - - OnSettingsChanged(); - dialog.Close(); - }; - - dialog.ShowDialog(); - } - } - - public class SettingsChangedEventArgs : CancelEventArgs - { - public HashSet Changed { get; } - public Settings OldSettings { get; } - public Settings NewSettings { get; } - - public SettingsChangedEventArgs(Settings oldSettings, Settings newSettings) - { - OldSettings = oldSettings; - NewSettings = newSettings; - Changed = new HashSet(); - foreach (var propertyInfo in typeof(Settings).GetProperties()) - { - var oldValue = propertyInfo.GetValue(oldSettings, null); - var newValue = propertyInfo.GetValue(newSettings, null); - if (oldValue != null && !oldValue.Equals(newValue)) - { - Trace.TraceInformation($"Setting {propertyInfo.Name} has changed"); - Changed.Add(propertyInfo.Name); - } - } - } - } -} diff --git a/lib/README.mkd b/lib/README.md similarity index 75% rename from lib/README.mkd rename to lib/README.md index f94bfeb..3bfb685 100644 --- a/lib/README.mkd +++ b/lib/README.md @@ -9,7 +9,7 @@ A .NET (Core) library for developing Notepad++ plugins ### License - (c) 2016-2024 Kasper B. Graversen, Mark Johnston Olson, Joakim Wennergren, Bas de Reuver, Robert Di Pardo + (c) 2016-2024 Kasper B. Graversen, Mark Johnston Olson, Robert Di Pardo Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -24,10 +24,10 @@ A .NET (Core) library for developing Notepad++ plugins limitations under the License. -See the [COPYRIGHT] and [NOTICE] for complete details regarding source code attribution and permitted usage. +See the [COPYING] and [NOTICE] files for complete details regarding source code attribution and permitted usage. -[COPYRIGHT]: https://raw.githubusercontent.com/npp-dotnet/npp.dotnet.plugin/main/COPYRIGHT +[COPYING]: https://raw.githubusercontent.com/npp-dotnet/npp.dotnet.plugin/main/COPYING [NOTICE]: https://raw.githubusercontent.com/npp-dotnet/npp.dotnet.plugin/main/NOTICE.txt [Current Version]: https://img.shields.io/nuget/vpre/Npp.DotNet.Plugin?color=blueviolet&logo=nuget [nuget-org]: https://www.nuget.org/packages/Npp.DotNet.Plugin diff --git a/lib/README.mkd.license b/lib/README.md.license similarity index 100% rename from lib/README.mkd.license rename to lib/README.md.license