extracted hard-coded platform definitions for unix32, unix64, win32A, win32W and win64 to actual platform files

firewave · firewave · commit 5daf1b25df43 · 2024-11-25T22:22:12.000+01:00
diff --git a/lib/platform.cpp b/lib/platform.cpp
@@ -63,86 +63,14 @@ bool Platform::set(Type t)
         return true;
     case Type::Win32W:
     case Type::Win32A:
-        type = t;
-        sizeof_bool = 1; // 4 in Visual C++ 4.2
-        sizeof_short = 2;
-        sizeof_int = 4;
-        sizeof_long = 4;
-        sizeof_long_long = 8;
-        sizeof_float = 4;
-        sizeof_double = 8;
-        sizeof_long_double = 8;
-        sizeof_wchar_t = 2;
-        sizeof_size_t = 4;
-        sizeof_pointer = 4;
-        defaultSign = '\0';
-        char_bit = 8;
-        short_bit = char_bit * sizeof_short;
-        int_bit = char_bit * sizeof_int;
-        long_bit = char_bit * sizeof_long;
-        long_long_bit = char_bit * sizeof_long_long;
-        return true;
     case Type::Win64:
-        type = t;
-        sizeof_bool = 1;
-        sizeof_short = 2;
-        sizeof_int = 4;
-        sizeof_long = 4;
-        sizeof_long_long = 8;
-        sizeof_float = 4;
-        sizeof_double = 8;
-        sizeof_long_double = 8;
-        sizeof_wchar_t = 2;
-        sizeof_size_t = 8;
-        sizeof_pointer = 8;
-        defaultSign = '\0';
-        char_bit = 8;
-        short_bit = char_bit * sizeof_short;
-        int_bit = char_bit * sizeof_int;
-        long_bit = char_bit * sizeof_long;
-        long_long_bit = char_bit * sizeof_long_long;
-        return true;
     case Type::Unix32:
-        type = t;
-        sizeof_bool = 1;
-        sizeof_short = 2;
-        sizeof_int = 4;
-        sizeof_long = 4;
-        sizeof_long_long = 8;
-        sizeof_float = 4;
-        sizeof_double = 8;
-        sizeof_long_double = 12;
-        sizeof_wchar_t = 4;
-        sizeof_size_t = 4;
-        sizeof_pointer = 4;
-        defaultSign = '\0';
-        char_bit = 8;
-        short_bit = char_bit * sizeof_short;
-        int_bit = char_bit * sizeof_int;
-        long_bit = char_bit * sizeof_long;
-        long_long_bit = char_bit * sizeof_long_long;
-        return true;
     case Type::Unix64:
         type = t;
-        sizeof_bool = 1;
-        sizeof_short = 2;
-        sizeof_int = 4;
-        sizeof_long = 8;
-        sizeof_long_long = 8;
-        sizeof_float = 4;
-        sizeof_double = 8;
-        sizeof_long_double = 16;
-        sizeof_wchar_t = 4;
-        sizeof_size_t = 8;
-        sizeof_pointer = 8;
-        defaultSign = '\0';
-        char_bit = 8;
-        short_bit = char_bit * sizeof_short;
-        int_bit = char_bit * sizeof_int;
-        long_bit = char_bit * sizeof_long;
-        long_long_bit = char_bit * sizeof_long_long;
+        // read from platform file
         return true;
     case Type::File:
+        type = t;
         // sizes are not set.
         return false;
     }
@@ -152,40 +80,73 @@ bool Platform::set(Type t)
 
 bool Platform::set(const std::string& platformstr, std::string& errstr, const std::vector<std::string>& paths, bool debug)
 {
-    if (platformstr == "win32A")
-        set(Type::Win32A);
-    else if (platformstr == "win32W")
-        set(Type::Win32W);
-    else if (platformstr == "win64")
-        set(Type::Win64);
-    else if (platformstr == "unix32")
-        set(Type::Unix32);
-    else if (platformstr == "unix64")
-        set(Type::Unix64);
-    else if (platformstr == "native")
-        set(Type::Native);
-    else if (platformstr == "unspecified")
-        set(Type::Unspecified);
+    Type t;
+    std::string platformFile;
+
+    if (platformstr == "win32A") {
+        // TODO: deprecate
+        //std::cout << "Platform 'win32A' is deprecated and will be removed in a future version. Please use 'win32a' instead." << std::endl;
+        t = Type::Win32A;
+        platformFile = "win32a";
+    }
+    else if (platformstr == "win32a") {
+        t = Type::Win32A;
+        platformFile = platformstr;
+    }
+    else if (platformstr == "win32W") {
+        // TODO: deprecate
+        //std::cout << "Platform 'win32W' is deprecated and will be removed in a future version. Please use 'win32w' instead." << std::endl;
+        t = Type::Win32W;
+        platformFile = "win32w";
+    }
+    else if (platformstr == "win32w") {
+        t = Type::Win32W;
+        platformFile = platformstr;
+    }
+    else if (platformstr == "win64") {
+        t = Type::Win64;
+        platformFile = platformstr;
+    }
+    else if (platformstr == "unix32") {
+        t = Type::Unix32;
+        platformFile = platformstr;
+    }
+    else if (platformstr == "unix64") {
+        t = Type::Unix64;
+        platformFile = platformstr;
+    }
+    else if (platformstr == "native") {
+        t = Type::Native;
+    }
+    else if (platformstr == "unspecified") {
+        t = Type::Unspecified;
+    }
     else if (paths.empty()) {
         errstr = "unrecognized platform: '" + platformstr + "' (no lookup).";
         return false;
     }
     else {
+        t = Type::File;
+        platformFile = platformstr;
+    }
+
+    if (!platformFile.empty()) {
         bool found = false;
         for (const std::string& path : paths) {
             if (debug)
-                std::cout << "looking for platform '" + platformstr + "' in '" + path + "'" << std::endl;
-            if (loadFromFile(path.c_str(), platformstr, debug)) {
+                std::cout << "looking for platform '" + platformFile + "' in '" + path + "'" << std::endl;
+            if (loadFromFile(path.c_str(), platformFile, debug)) {
                 found = true;
                 break;
             }
         }
         if (!found) {
-            errstr = "unrecognized platform: '" + platformstr + "'.";
+            errstr = "unrecognized platform: '" + platformFile + "'.";
             return false;
         }
     }
 
+    set(t);
     return true;
 }
 
@@ -248,6 +209,7 @@ bool Platform::loadFromXmlDocument(const tinyxml2::XMLDocument *doc)
     if (!rootnode || std::strcmp(rootnode->Name(), "platform") != 0)
         return false;
 
+    // TODO: warn about missing fields
     bool error = false;
     for (const tinyxml2::XMLElement *node = rootnode->FirstChildElement(); node; node = node->NextSiblingElement()) {
         const char* name = node->Name();
@@ -293,7 +255,6 @@ bool Platform::loadFromXmlDocument(const tinyxml2::XMLDocument *doc)
     long_bit = char_bit * sizeof_long;
     long_long_bit = char_bit * sizeof_long_long;
 
-    type = Type::File;
     return !error;
 }
 
diff --git a/platforms/unix32.xml b/platforms/unix32.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<platform>
+  <char_bit>8</char_bit>
+  <default-sign>&#x000;</default-sign>
+  <sizeof>
+    <bool>1</bool>
+    <short>2</short>
+    <int>4</int>
+    <long>4</long>
+    <long-long>8</long-long>
+    <float>4</float>
+    <double>8</double>
+    <long-double>12</long-double>
+    <pointer>4</pointer>
+    <size_t>4</size_t>
+    <wchar_t>4</wchar_t>
+  </sizeof>
+</platform>
diff --git a/platforms/unix64.xml b/platforms/unix64.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<platform>
+  <char_bit>8</char_bit>
+  <default-sign>&#x000;</default-sign>
+  <sizeof>
+    <bool>1</bool>
+    <short>2</short>
+    <int>4</int>
+    <long>8</long>
+    <long-long>8</long-long>
+    <float>4</float>
+    <double>8</double>
+    <long-double>16</long-double>
+    <pointer>8</pointer>
+    <size_t>8</size_t>
+    <wchar_t>4</wchar_t>
+  </sizeof>
+</platform>
diff --git a/platforms/win32a.xml b/platforms/win32a.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<platform>
+  <char_bit>8</char_bit>
+  <default-sign>&#x000;</default-sign>
+  <sizeof>
+    <bool>1</bool><!--4 in Visual C++ 4.2-->
+    <short>2</short>
+    <int>4</int>
+    <long>4</long>
+    <long-long>8</long-long>
+    <float>4</float>
+    <double>8</double>
+    <long-double>8</long-double>
+    <pointer>4</pointer>
+    <size_t>4</size_t>
+    <wchar_t>2</wchar_t>
+  </sizeof>
+</platform>
diff --git a/platforms/win32w.xml b/platforms/win32w.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<platform>
+  <char_bit>8</char_bit>
+  <default-sign>&#x000;</default-sign>
+  <sizeof>
+    <bool>1</bool><!--4 in Visual C++ 4.2-->
+    <short>2</short>
+    <int>4</int>
+    <long>4</long>
+    <long-long>8</long-long>
+    <float>4</float>
+    <double>8</double>
+    <long-double>8</long-double>
+    <pointer>4</pointer>
+    <size_t>4</size_t>
+    <wchar_t>2</wchar_t>
+  </sizeof>
+</platform>
diff --git a/platforms/win64.xml b/platforms/win64.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<platform>
+  <char_bit>8</char_bit>
+  <default-sign>&#x000;</default-sign>
+  <sizeof>
+    <bool>1</bool>
+    <short>2</short>
+    <int>4</int>
+    <long>4</long>
+    <long-long>8</long-long>
+    <float>4</float>
+    <double>8</double>
+    <long-double>8</long-double>
+    <pointer>8</pointer>
+    <size_t>8</size_t>
+    <wchar_t>2</wchar_t>
+  </sizeof>
+</platform>
diff --git a/releasenotes.txt b/releasenotes.txt
@@ -16,5 +16,6 @@ Deprecations:
 -
 
 Other:
-- Removed deperecated support for builds via qmake.
+- Removed deprecated support for builds via qmake.
+- The `win32a` and `win32w` aliases have been added for the platforms `win32A` and `win32W` respectively.
 -
diff --git a/test/cli/other_test.py b/test/cli/other_test.py
@@ -2276,3 +2276,43 @@ def test_dumpfile_platform(tmpdir):
                 break
     assert ' wchar_t_bit="' in platform
     assert ' size_t_bit="' in platform
+
+
+def test_custom_platform(tmpdir):
+    test_cfg = os.path.join(tmpdir, 'test.cfg')
+    with open(test_cfg, 'wt') as f:
+        f.write("""
+<?xml version="1.0"?>
+<platform>
+    <char_bit>8</char_bit>
+    <default-sign>unsigned</default-sign>
+    <sizeof>
+        <bool>1</bool>
+        <short>2</short>
+        <int>2</int>
+        <long>4</long>
+        <long-long>8</long-long>
+        <float>4</float>
+        <double>4</double>
+        <long-double>4</long-double>
+        <pointer>2</pointer>
+        <size_t>2</size_t>
+        <wchar_t>2</wchar_t>
+    </sizeof>
+</platform>
+        """)
+
+    # TODO: use a sample to make sure the file is actually used
+    test_file = os.path.join(tmpdir, 'test.cpp')
+    with open(test_file, 'wt') as f:
+        f.write("""
+        """)
+    args = ['--platform={}'.format(test_cfg), test_file]
+
+    exitcode, stdout, stderr = cppcheck(args)
+    assert exitcode == 0, stdout
+    lines = stdout.splitlines()
+    assert lines == [
+        'Checking {} ...'.format(test_file)
+    ]
+    assert stderr == ''
diff --git a/test/cli/test-other.py b/test/cli/test-other.py
diff --git a/test/testcmdlineparser.cpp b/test/testcmdlineparser.cpp
@@ -243,7 +243,9 @@ class TestCmdlineParser : public TestFixture {
         TEST_CASE(stdmulti2);
         TEST_CASE(platformWin64);
         TEST_CASE(platformWin32A);
+        TEST_CASE(platformWin32a);
         TEST_CASE(platformWin32W);
+        TEST_CASE(platformWin32w);
         TEST_CASE(platformUnix32);
         TEST_CASE(platformUnix32Unsigned);
         TEST_CASE(platformUnix64);
@@ -1534,6 +1536,15 @@ class TestCmdlineParser : public TestFixture {
         ASSERT_EQUALS(Platform::Type::Win32A, settings->platform.type);
     }
 
+    void platformWin32a() {
+        REDIRECT;
+        const char * const argv[] = {"cppcheck", "--platform=win32a", "file.cpp"};
+        ASSERT(settings->platform.set(cppcheck::Platform::Type::Unspecified));
+        ASSERT(parser->parseFromArgs(3, argv));
+        ASSERT_EQUALS(cppcheck::Platform::Type::Win32A, settings->platform.type);
+        ASSERT_EQUALS("", GET_REDIRECT_OUTPUT);
+    }
+
     void platformWin32W() {
         REDIRECT;
         const char * const argv[] = {"cppcheck", "--platform=win32W", "file.cpp"};
@@ -1542,6 +1553,15 @@ class TestCmdlineParser : public TestFixture {
         ASSERT_EQUALS(Platform::Type::Win32W, settings->platform.type);
     }
 
+    void platformWin32w() {
+        REDIRECT;
+        const char * const argv[] = {"cppcheck", "--platform=win32w", "file.cpp"};
+        ASSERT(settings->platform.set(cppcheck::Platform::Type::Unspecified));
+        ASSERT(parser->parseFromArgs(3, argv));
+        ASSERT_EQUALS(cppcheck::Platform::Type::Win32W, settings->platform.type);
+        ASSERT_EQUALS("", GET_REDIRECT_OUTPUT);
+    }
+
     void platformUnix32() {
         REDIRECT;
         const char * const argv[] = {"cppcheck", "--platform=unix32", "file.cpp"};
diff --git a/test/testplatform.cpp b/test/testplatform.cpp

Original file line number	Diff line number	Diff line change
`@@ -16,5 +16,6 @@ Deprecations:`
`16`	`16`	`-`
`17`	`17`
`18`	`18`	`Other:`
`19`		`-- Removed deperecated support for builds via qmake.`
	`19`	`+- Removed deprecated support for builds via qmake.`
	`20`	+- The `win32a` and `win32w` aliases have been added for the platforms `win32A` and `win32W` respectively.
`20`	`21`	`-`