Change license from MIT to BSD 3-Clause (#50)

- Align the license with the other Team CharLS projects.
- Use .hpp for all header files
- Rename factory into codec_factory

Author: vbaderks

.clang-format

@@ -1,5 +1,5 @@
-# Copyright (c) Victor Derks.
-# SPDX-License-Identifier: MIT
+# Copyright (c) Team CharLS.
+# SPDX-License-Identifier: BSD-3-Clause
 
 BasedOnStyle: LLVM
 Language: Cpp
@@ -39,4 +39,4 @@ SpaceAfterTemplateKeyword: false
 SpaceBeforeCpp11BracedList: false
 KeepEmptyLinesAtTheStartOfBlocks: false
 MaxEmptyLinesToKeep: 2
-NamespaceIndentation: None
+NamespaceIndentation: None

.clang-tidy

@@ -1,5 +1,5 @@
-// Copyright (c) Victor Derks.
-// SPDX-License-Identifier: MIT
+# Copyright (c) Team CharLS.
+# SPDX-License-Identifier: BSD-3-Clause
 
 # The approach for using clang tidy is to enable all warnings unless it adds no practical value to the Netpbm WIC Codec project
 # Having all warnings enables helps to find problems when new code is added to the project. Some warnings are however

.editorconfig

@@ -1,5 +1,5 @@
-# Copyright (c) Victor Derks.
-# SPDX-License-Identifier: MIT
+# Copyright (c) Team CharLS.
+# SPDX-License-Identifier: BSD-3-Clause
 
 root = true
 

.gitattributes

@@ -1,5 +1,5 @@
-# Copyright (c) Victor Derks
-# SPDX-License-Identifier: MIT
+# Copyright (c) Team CharLS.
+# SPDX-License-Identifier: BSD-3-Clause
 
 # Set default behavior to automatically normalize line endings.
 * text=auto

.github/dependabot.yml

@@ -1,5 +1,5 @@
-# Copyright (c) Victor Derks.
-# SPDX-License-Identifier: MIT
+# Copyright (c) Team CharLS.
+# SPDX-License-Identifier: BSD-3-Clause
 
 version: 2
 

.github/workflows/msbuild.yml

@@ -1,5 +1,5 @@
-# Copyright (c) Victor Derks.
-# SPDX-License-Identifier: MIT
+# Copyright (c) Team CharLS.
+# SPDX-License-Identifier: BSD-3-Clause
 
 name: Build and test
 

.gitignore

@@ -1,5 +1,5 @@
-# Copyright (c) Victor Derks.
-# SPDX-License-Identifier: MIT
+# Copyright (c) Team CharLS.
+# SPDX-License-Identifier: BSD-3-Clause
 
 bin/
 .vscode/
@@ -12,4 +12,4 @@ packages/
 
 *.user
 *.aps
-*.binlog
+*.binlog

LICENSE.md

@@ -1,21 +1,29 @@
-MIT License
+BSD 3-Clause License
 
-Copyright (c) 2021 Victor Derks
+Copyright (c) 2021 Team CharLS
+All rights reserved.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

cpp.hint

@@ -1,3 +1,6 @@
+// Copyright (c) Team CharLS.
+// SPDX-License-Identifier: BSD-3-Clause
+
 // Hint files help the Visual Studio IDE interpret Visual C++ identifiers
 // such as names of functions and macros.
 // For more information see https://go.microsoft.com/fwlink/?linkid=865984

default.ruleset

@@ -3,19 +3,16 @@
   <IncludeAll Action="Error" />
   <Rules AnalyzerId="Microsoft.Analyzers.NativeCodeAnalysis" RuleNamespace="Microsoft.Rules.Native">
     <Rule Id="C26429" Action="None" />
-    <Rule Id="C26435" Action="None" />
     <Rule Id="C26446" Action="None" />
     <Rule Id="C26459" Action="None" />
     <Rule Id="C26466" Action="None" />
     <Rule Id="C26472" Action="None" />
-    <Rule Id="C26478" Action="None" />
     <Rule Id="C26481" Action="None" />
     <Rule Id="C26482" Action="None" />
     <Rule Id="C26485" Action="None" />
     <Rule Id="C26490" Action="None" />
     <Rule Id="C26491" Action="None" />
     <Rule Id="C26494" Action="None" />
     <Rule Id="C26821" Action="None" />
-    <Rule Id="C28290" Action="None" />
   </Rules>
 </RuleSet>

default.ruleset.md

@@ -11,9 +11,6 @@ Most of these rules\warning are based on the C++ Core Guidelines.
 - C26429: Use a not_null to indicate that "null" is not a valid value  
 **Rationale**: Prefast attributes (\_In_, etc.) are better than gsl::not_null.
 
-- C26435: Function '' should specify exactly one of 'virtual', 'override', or 'final' (c.128).
-**Rationale**: False warning in Visual Studio 2022 Version 17.5.0 Preview 1.0.
-
 - C26446: Prefer to use gsl::at() instead of unchecked subscript operator.  
 **Rationale**: gsl:at() cannot be used as gsl project is by design not included. MSVC STL in debug mode already checks access.
 
@@ -26,9 +23,6 @@ Most of these rules\warning are based on the C++ Core Guidelines.
 - C26472: Don't use static_cast for arithmetic conversions  
 **Rationale**: can only be solved with gsl::narrow_cast
 
-- C26478: Don't use std::move on constant variables. (es.56).
-**Rationale**: false warnings (VS 2022 17.7.0 Preview 3.0)
-
 - C26481: Do not pass an array as a single pointer.  
 **Rationale**: gsl::span is not available.
 
@@ -45,8 +39,5 @@ Most of these rules\warning are based on the C++ Core Guidelines.
 **Rationale**: many false warnings due to output parameters. Other analyzers are better
 as they check if the variable is used before initialized.
 
-- C26821: For '', consider using gsl::span instead of std::span to guarantee runtime bounds safety (gsl.view)
+- C26821: For '', consider using gsl::span instead of std::span to guarantee runtime bounds safety (gsl.view)  
 **Rationale**: preference is to use types from the std namespace.
-
-- C28290: The annotation for function '{ctor}' contains more Externals than the actual number of parameters.
-**Rationale**: false warnings (VS 2022 17.4.0)

netpbm-wic-codec.sln.DotSettings

@@ -1,8 +1,10 @@
 <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
 	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=CppClangTidyBugproneBranchClone/@EntryIndexedValue">DO_NOT_SHOW</s:String>
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=CppClangTidyBugproneEmptyCatch/@EntryIndexedValue">DO_NOT_SHOW</s:String>
 	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=CppClassCanBeFinal/@EntryIndexedValue">DO_NOT_SHOW</s:String>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=anymap/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=bugprone/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=charls/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=CLSID/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=cppcoreguidelines/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=defacto/@EntryIndexedValue">True</s:Boolean>

src/buffered_stream_reader.cpp

@@ -1,5 +1,5 @@
-// Copyright (c) Victor Derks.
-// SPDX-License-Identifier: MIT
+// Copyright (c) Team CharLS.
+// SPDX-License-Identifier: BSD-3-Clause
 
 module;
 
@@ -8,7 +8,7 @@ module;
 
 module buffered_stream_reader;
 
-import <win.h>;
+import <win.hpp>;
 
 import errors;
 import util;

src/buffered_stream_reader.ixx

@@ -1,13 +1,13 @@
-// Copyright (c) Victor Derks.
-// SPDX-License-Identifier: MIT
+// Copyright (c) Team CharLS.
+// SPDX-License-Identifier: BSD-3-Clause
 
 module;
 
 #include "intellisense.hpp"
 
 export module buffered_stream_reader;
 
-import <win.h>;
+import <win.hpp>;
 import std;
 import winrt;
 

src/class_factory.ixx

@@ -1,9 +1,9 @@
-// Copyright (c) Victor Derks.
-// SPDX-License-Identifier: MIT
+// Copyright (c) Team CharLS.
+// SPDX-License-Identifier: BSD-3-Clause
 
 export module class_factory;
 
-import <win.h>;
+import <win.hpp>;
 import winrt;
 
 import errors;

src/dll_main.cpp

@@ -1,11 +1,11 @@
-// Copyright (c) Victor Derks.
-// SPDX-License-Identifier: MIT
+// Copyright (c) Team CharLS.
+// SPDX-License-Identifier: BSD-3-Clause
 
 #include "macros.hpp"
-#include "version.h"
+#include "version.hpp"
 
 import std;
-import <win.h>;
+import <win.hpp>;
 import winrt;
 
 import netpbm_bitmap_decoder;
@@ -30,7 +30,7 @@ void register_general_decoder_settings(const GUID& class_id, const GUID& wic_cat
 {
     const wstring sub_key = LR"(SOFTWARE\Classes\CLSID\)" + guid_to_string(class_id);
     registry::set_value(sub_key, L"ArbitrationPriority", 10);
-    registry::set_value(sub_key, L"Author", L"Victor Derks");
+    registry::set_value(sub_key, L"Author", L"Team CharLS");
     registry::set_value(sub_key, L"ColorManagementVersion", L"1.0.0.0");
     registry::set_value(sub_key, L"ContainerFormat", guid_to_string(id::container_format_netpbm).c_str());
     registry::set_value(sub_key, L"Description", L"Netpbm Codec");
@@ -42,7 +42,7 @@ void register_general_decoder_settings(const GUID& class_id, const GUID& wic_cat
     registry::set_value(sub_key, L"SupportChromaKey", 0U);
     registry::set_value(sub_key, L"SupportLossless", 1U);
     registry::set_value(sub_key, L"SupportMultiframe", 0U);
-    registry::set_value(sub_key, L"Vendor", guid_to_string(id::vendor_victor_derks).c_str());
+    registry::set_value(sub_key, L"Vendor", guid_to_string(id::vendor_team_charls).c_str());
     registry::set_value(sub_key, L"Version", VERSION);
 
     const wstring formats_sub_key{sub_key + LR"(\Formats\)"};
@@ -103,7 +103,7 @@ void register_decoder()
 {
     array formats{&GUID_WICPixelFormat2bppGray, &GUID_WICPixelFormat4bppGray, &GUID_WICPixelFormat8bppGray,
                   &GUID_WICPixelFormat16bppGray, &GUID_WICPixelFormat24bppRGB};
-    register_general_decoder_settings(id::netpbm_decoder, CATID_WICBitmapDecoders, L"Netpbm Decoder", formats);
+    register_general_decoder_settings(id::netpbm_decoder, CATID_WICBitmapDecoders, L"Team CharLS Netpbm Decoder", formats);
 
     const wstring sub_key{LR"(SOFTWARE\Classes\CLSID\)" + guid_to_string(id::netpbm_decoder)};
 
@@ -200,7 +200,7 @@ HRESULT __stdcall DllUnregisterServer()
 try
 {
     TRACE("netpbm-wic-codec::DllUnregisterServer\n");
-    // Note: keep the .pgm file registration intact.
+    // Note: keep the file registrations intact.
     return unregister(id::netpbm_decoder, CATID_WICBitmapDecoders);
 }
 catch (...)

src/errors.ixx

@@ -1,13 +1,13 @@
-// Copyright (c) Victor Derks.
-// SPDX-License-Identifier: MIT
+// Copyright (c) Team CharLS.
+// SPDX-License-Identifier: BSD-3-Clause
 
 module;
 
 #include "intellisense.hpp"
 
 export module errors;
 
-import <win.h>;
+import <win.hpp>;
 
 export {
 

src/guids.ixx

@@ -1,9 +1,9 @@
-// Copyright (c) Victor Derks.
-// SPDX-License-Identifier: MIT
+// Copyright (c) Team CharLS.
+// SPDX-License-Identifier: BSD-3-Clause
 
 export module guids;
 
-import <win.h>;
+import <win.hpp>;
 
 export namespace id {
 
@@ -13,7 +13,7 @@ constexpr GUID netpbm_decoder{0x6891bbe, 0xcc02, 0x4bb2, {0x9c, 0xf0, 0x30, 0x3f
 // {70ab66f5-cd48-43a1-aa29-10131b7f4ff1}
 constexpr GUID container_format_netpbm{0x70ab66f5, 0xcd48, 0x43a1, {0xaa, 0x29, 0x10, 0x13, 0x1b, 0x7f, 0x4f, 0xf1}};
 
-// {87a8e9f4-8aac-4667-bcfd-56535c80a269}
-constexpr GUID vendor_victor_derks{0x87a8e9f4, 0x8aac, 0x4667, {0xbc, 0xfd, 0x56, 0x53, 0x5c, 0x80, 0xa2, 0x69}};
+// {8adbe21c-a720-424e-b238-45ad1052b98c}
+constexpr GUID vendor_team_charls{0x8adbe21c, 0xa720, 0x424e, {0xb2, 0x38, 0x45, 0xad, 0x10, 0x52, 0xb9, 0x8c}};
 
 }

src/intellisense.hpp

@@ -1,10 +1,12 @@
-// Copyright (c) Victor Derks.
-// SPDX-License-Identifier: MIT
+// Copyright (c) Team CharLS.
+// SPDX-License-Identifier: BSD-3-Clause
 
 #pragma once
 
-// Include explicit headers as workaround that IntelliSense in VS 2022 17.12 fails to parse #import <win.h>
+// Include explicit headers as workaround that IntelliSense (VS 2022 17.12)
+// and ReSharper (2024.2.5) fail to parse #import <win.hpp>
 #if defined(__INTELLISENSE__) || defined(__RESHARPER__)
+// ReSharper disable once CppInconsistentNaming
 #define _AMD64_
 #include <combaseapi.h>
 #include <libloaderapi.h>

src/macros.hpp

@@ -1,5 +1,5 @@
-// Copyright (c) Victor Derks.
-// SPDX-License-Identifier: MIT
+// Copyright (c) Team CharLS.
+// SPDX-License-Identifier: BSD-3-Clause
 
 #pragma once
 

src/netpbm-wic-codec.def

@@ -1,5 +1,8 @@
+; Copyright (c) Team CharLS.
+; SPDX-License-Identifier: BSD-3-Clause
+
 EXPORTS
     DllCanUnloadNow     PRIVATE
     DllGetClassObject   PRIVATE
     DllRegisterServer   PRIVATE
-    DllUnregisterServer PRIVATE
+    DllUnregisterServer PRIVATE

src/netpbm-wic-codec.rc

@@ -1,9 +1,9 @@
-// Copyright (c) Victor Derks
-// SPDX-License-Identifier: MIT
+// Copyright (c) Team CharLS.
+// SPDX-License-Identifier: BSD-3-Clause
 
 #pragma code_page(65001)
 
-#include "version.h"
+#include "version.hpp"
 
 #include <winres.h>
 
@@ -13,10 +13,10 @@ VS_VERSION_INFO VERSIONINFO
  FILEVERSION VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH, 0
  PRODUCTVERSION VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH, 0
  FILEFLAGSMASK 0x3fL
-#ifdef _DEBUG
- FILEFLAGS 0x1L
-#else
+#ifdef NDEBUG
  FILEFLAGS 0x0L
+#else
+ FILEFLAGS 0x1L
 #endif
  FILEOS 0x40004L
  FILETYPE 0x2L
@@ -26,11 +26,11 @@ BEGIN
     BEGIN
         BLOCK "000004b0"
         BEGIN
-            VALUE "CompanyName", "Victor Derks"
+            VALUE "CompanyName", "Team CharLS"
             VALUE "FileDescription", L"Netpbm WIC codec"
             VALUE "FileVersion", VERSION
             VALUE "InternalName", L"netpbm-wic-codec.dll"
-            VALUE "LegalCopyright", L"Copyright (c) Victor Derks"
+            VALUE "LegalCopyright", L"Copyright (c) Team CharLS"
             VALUE "OriginalFilename", L"netpbm-wic-codec.dll"
             VALUE "ProductName", L"Netpbm WIC codec"
             VALUE "ProductVersion", VERSION