Adding upstream version 4:24.2.0.upstream/4%24.2.0

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 426 insertions, 0 deletions

diff --git a/compilerplugins/clang/test/unusedfields.cxx b/compilerplugins/clang/test/unusedfields.cxx
new file mode 100644
index 0000000000..c936460bbe
--- /dev/null
+++ b/compilerplugins/clang/test/unusedfields.cxx
@@ -0,0 +1,426 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+#if defined _WIN32 // TODO, see corresponding TODO in compilerplugins/clang/unusedfields.cxx
+// expected-no-diagnostics
+#else
+
+#include <map>
+#include <memory>
+#include <vector>
+#include <ostream>
+#include <com/sun/star/uno/Any.hxx>
+#include <com/sun/star/uno/Sequence.hxx>
+#include <com/sun/star/uno/XInterface.hpp>
+#include <rtl/ref.hxx>
+
+struct Foo
+// expected-error@-1 {{read m_foo1 [loplugin:unusedfields]}}
+// expected-error@-2 {{outside m_foo1 [loplugin:unusedfields]}}
+{
+    int m_foo1;
+};
+
+struct Bar
+// expected-error@-1 {{read m_bar2 [loplugin:unusedfields]}}
+// expected-error@-2 {{read m_bar4 [loplugin:unusedfields]}}
+// expected-error@-3 {{read m_bar5 [loplugin:unusedfields]}}
+// expected-error@-4 {{read m_bar6 [loplugin:unusedfields]}}
+// expected-error@-5 {{read m_barfunctionpointer [loplugin:unusedfields]}}
+// expected-error@-6 {{read m_bar8 [loplugin:unusedfields]}}
+// expected-error@-7 {{read m_bar10 [loplugin:unusedfields]}}
+// expected-error@-8 {{read m_bar11 [loplugin:unusedfields]}}
+// expected-error@-9 {{write m_bar1 [loplugin:unusedfields]}}
+// expected-error@-10 {{write m_bar2 [loplugin:unusedfields]}}
+// expected-error@-11 {{write m_bar3 [loplugin:unusedfields]}}
+// expected-error@-12 {{write m_bar3b [loplugin:unusedfields]}}
+// expected-error@-13 {{write m_bar4 [loplugin:unusedfields]}}
+// expected-error@-14 {{write m_bar7 [loplugin:unusedfields]}}
+// expected-error@-15 {{write m_bar9 [loplugin:unusedfields]}}
+// expected-error@-16 {{write m_bar12 [loplugin:unusedfields]}}
+// expected-error@-17 {{outside-constructor m_bar2 [loplugin:unusedfields]}}
+// expected-error@-18 {{outside-constructor m_bar3 [loplugin:unusedfields]}}
+// expected-error@-19 {{outside-constructor m_bar3b [loplugin:unusedfields]}}
+// expected-error@-20 {{outside-constructor m_bar4 [loplugin:unusedfields]}}
+// expected-error@-21 {{outside-constructor m_bar5 [loplugin:unusedfields]}}
+// expected-error@-22 {{outside-constructor m_bar6 [loplugin:unusedfields]}}
+// expected-error@-23 {{outside-constructor m_bar7 [loplugin:unusedfields]}}
+// expected-error@-24 {{outside-constructor m_bar8 [loplugin:unusedfields]}}
+// expected-error@-25 {{outside-constructor m_bar9 [loplugin:unusedfields]}}
+// expected-error@-26 {{outside-constructor m_bar10 [loplugin:unusedfields]}}
+// expected-error@-27 {{outside-constructor m_bar11 [loplugin:unusedfields]}}
+// expected-error@-28 {{outside-constructor m_bar12 [loplugin:unusedfields]}}
+// expected-error@-29 {{outside-constructor m_barfunctionpointer [loplugin:unusedfields]}}
+// expected-error@-30 {{outside m_barstream [loplugin:unusedfields]}}
+{
+    int  m_bar1;
+    int  m_bar2 = 1;
+    int* m_bar3;
+    int* m_bar3b;
+    int  m_bar4;
+    void (*m_barfunctionpointer)(int&);
+    int  m_bar5;
+    std::vector<int> m_bar6;
+    int m_bar7[5];
+    int m_bar8;
+    int m_barstream;
+    sal_Int32 m_bar9;
+    sal_Int32 m_bar10;
+    css::uno::Any m_bar11;
+    css::uno::Any m_bar12;
+
+    // check that we see reads of fields like m_foo1 when referred to via constructor initializer
+    Bar(Foo const & foo) : m_bar1(foo.m_foo1) {}
+
+    // check that we don't see reads when inside copy/move constructor
+    Bar(Bar const & other) { m_bar3 = other.m_bar3; }
+
+    // check that we don't see reads when inside copy/move assignment operator
+    Bar& operator=(Bar const & other) { m_bar3 = other.m_bar3; return *this; }
+
+    // check that we DON'T see reads here
+    int bar2() { return m_bar2; }
+
+    // check that we DON'T see reads here
+    void bar3()
+    {
+        m_bar3 = nullptr;
+        m_bar3b = m_bar3 = nullptr;
+    }
+
+    // check that we see reads of field when passed to a function pointer
+    // check that we see read of a field that is a function pointer
+    void bar4() { m_barfunctionpointer(m_bar4); }
+
+    // check that we see reads of a field when used in variable init
+    void bar5() { int x = m_bar5; (void) x; }
+
+    // check that we see reads of a field when used in ranged-for
+    void bar6() { for (auto i : m_bar6) { (void)i; } }
+
+    // check that we see don't see reads of array fields
+    void bar7() { m_bar7[3] = 1; }
+
+    // check that we see reads when a field is used in an array expression
+    char bar8()
+    {
+        char tmp[5];
+        return tmp[m_bar8];
+    }
+
+    // check that we don't see reads when calling operator>>=
+    void bar9()
+    {
+        css::uno::Any any;
+        any >>= m_bar9;
+    }
+
+    // check that we see don't see writes when calling operator<<=
+    void bar10()
+    {
+        css::uno::Any any;
+        any <<= m_bar10;
+        (void)any;
+    }
+
+    // check that we see reads of the LHS when calling operator>>=
+    void bar11()
+    {
+        int x;
+        m_bar11 >>= x;
+    }
+
+    // check that we see writes of the LHS when calling operator<<=
+    void bar12()
+    {
+        int x = 0;
+        m_bar12 <<= x;
+    }
+};
+
+// check that we __dont__ see a read of m_barstream
+std::ostream& operator<<(std::ostream& s, Bar const & bar)
+{
+    s << bar.m_barstream;
+    return s;
+};
+
+struct ReadOnly1 { ReadOnly1(int&); };
+
+struct ReadOnlyAnalysis
+// expected-error@-1 {{read m_f2 [loplugin:unusedfields]}}
+// expected-error@-2 {{read m_f3 [loplugin:unusedfields]}}
+// expected-error@-3 {{read m_f5 [loplugin:unusedfields]}}
+// expected-error@-4 {{read m_f6 [loplugin:unusedfields]}}
+// expected-error@-5 {{write m_f2 [loplugin:unusedfields]}}
+// expected-error@-6 {{write m_f3 [loplugin:unusedfields]}}
+// expected-error@-7 {{write m_f4 [loplugin:unusedfields]}}
+// expected-error@-8 {{write m_f5 [loplugin:unusedfields]}}
+// expected-error@-9 {{write m_f6 [loplugin:unusedfields]}}
+// expected-error@-10 {{outside-constructor m_f2 [loplugin:unusedfields]}}
+// expected-error@-11 {{outside-constructor m_f3 [loplugin:unusedfields]}}
+// expected-error@-12 {{outside-constructor m_f4 [loplugin:unusedfields]}}
+// expected-error@-13 {{outside-constructor m_f5 [loplugin:unusedfields]}}
+// expected-error@-14 {{outside-constructor m_f6 [loplugin:unusedfields]}}
+{
+    int m_f1;
+    int m_f2;
+    int m_f3;
+    std::vector<int> m_f4;
+    int m_f5;
+    int m_f6;
+
+    // check that we don't see a write of m_f1
+    ReadOnlyAnalysis() : m_f1(0) {}
+
+    void method1(int&);
+
+    // check that we see a write when we pass by non-const ref
+    void method2() { method1(m_f2); }
+
+    int& method3() { return m_f3; }
+
+    void method4() { m_f4.push_back(1); }
+
+    // check that we see a write when we pass by non-const ref
+    void method5() { ReadOnly1 a(m_f5); }
+
+    // check that we see a write when we pass by non-const ref
+    void method6()
+    {
+        int& r = m_f6;
+        r = 1;
+    }
+};
+
+struct ReadOnlyAnalysis2
+// expected-error@-1 {{write m_r2f1 [loplugin:unusedfields]}}
+{
+    int m_r2f1;
+};
+
+ReadOnlyAnalysis2 global { 1 };
+
+struct ReadOnlyAnalysis3
+// expected-error@-1 {{read m_f1 [loplugin:unusedfields]}}
+// expected-error@-2 {{outside-constructor m_f1 [loplugin:unusedfields]}}
+{
+    int m_f1;
+
+    void func1()
+    {
+        if (m_f1)
+            m_f1 = 1;
+    }
+};
+
+// Verify the special logic for container fields that only contains mutations that
+// add elements.
+struct ReadOnlyAnalysis4
+// expected-error@-1 {{read m_readonly [loplugin:unusedfields]}}
+// expected-error@-2 {{write m_writeonly [loplugin:unusedfields]}}
+// expected-error@-3 {{read m_readonlyCss [loplugin:unusedfields]}}
+// expected-error@-4 {{outside-constructor m_readonly [loplugin:unusedfields]}}
+// expected-error@-5 {{outside-constructor m_readonlyCss [loplugin:unusedfields]}}
+// expected-error@-6 {{outside-constructor m_writeonly [loplugin:unusedfields]}}
+{
+    std::vector<int> m_readonly;
+    std::vector<int> m_writeonly;
+    css::uno::Sequence<sal_Int32> m_readonlyCss;
+
+    void func1()
+    {
+        int x = m_readonly[0];
+        (void)x;
+        *m_readonly.begin() = 1;
+
+        m_writeonly.push_back(0);
+        m_writeonly.clear();
+
+        x = m_readonlyCss.getArray()[0];
+    }
+};
+
+template<class T>
+struct VclPtr
+{
+    VclPtr(T*);
+    void clear();
+};
+
+// Check calls to operators
+struct WriteOnlyAnalysis2
+// expected-error@-1 {{write m_vclwriteonly [loplugin:unusedfields]}}
+// expected-error@-2 {{outside-constructor m_vclwriteonly [loplugin:unusedfields]}}
+{
+    VclPtr<int> m_vclwriteonly;
+
+    WriteOnlyAnalysis2() : m_vclwriteonly(nullptr)
+    {
+        m_vclwriteonly = nullptr;
+    }
+
+    ~WriteOnlyAnalysis2()
+    {
+        m_vclwriteonly.clear();
+    }
+};
+
+namespace WriteOnlyAnalysis3
+{
+    void setFoo(int);
+    struct Foo1
+    // expected-error@-1 {{read m_field1 [loplugin:unusedfields]}}
+    // expected-error@-2 {{write m_field1 [loplugin:unusedfields]}}
+    // expected-error@-3 {{outside-constructor m_field1 [loplugin:unusedfields]}}
+    {
+        int m_field1;
+        Foo1() : m_field1(1) {}
+        ~Foo1()
+        {
+            setFoo(m_field1);
+        }
+    };
+};
+
+// Check that writes to fields that are wrapped by conditional checks are ignored,
+// where those conditional checks use an 'operator bool'
+namespace ReadOnlyAnalysis5
+{
+    struct RefTarget
+    {
+        void acquire();
+        void release();
+    };
+    struct Foo1
+    // expected-error@-1 {{read m_field1 [loplugin:unusedfields]}}
+    // expected-error@-2 {{read m_field2 [loplugin:unusedfields]}}
+    // expected-error@-3 {{read m_field3xx [loplugin:unusedfields]}}
+    // expected-error@-4 {{outside-constructor m_field1 [loplugin:unusedfields]}}
+    // expected-error@-5 {{outside-constructor m_field2 [loplugin:unusedfields]}}
+    // expected-error@-6 {{outside-constructor m_field3xx [loplugin:unusedfields]}}
+    {
+        std::unique_ptr<int> m_field1;
+        rtl::Reference<RefTarget> m_field2;
+        css::uno::Reference<css::uno::XInterface> m_field3xx;
+        void f1(css::uno::Reference<css::uno::XInterface> a)
+        {
+            if (m_field1)
+                m_field1.reset(new int);
+            if (m_field1.get())
+                m_field1.reset(new int);
+            if (m_field2)
+                m_field2 = new RefTarget;
+            if (m_field2.get())
+                m_field2 = new RefTarget;
+            if (m_field3xx)
+                m_field3xx = a;
+            if (m_field3xx.get())
+                m_field3xx = a;
+        }
+    };
+};
+
+
+namespace TouchFromOutsideConstructorAnalysis1
+{
+    struct RenderContextGuard
+    // expected-error@-1 {{write m_pRef [loplugin:unusedfields]}}
+    // expected-error@-2 {{read m_pRef [loplugin:unusedfields]}}
+    // expected-error@-3 {{write m_pOriginalValue [loplugin:unusedfields]}}
+    {
+        int& m_pRef;
+        int m_pOriginalValue;
+
+        RenderContextGuard(int& pRef, int pValue)
+            : m_pRef(pRef),
+              m_pOriginalValue(m_pRef)
+        {
+            m_pRef = pValue;
+        }
+    };
+};
+
+namespace TouchFromOutsideAnalysis1
+{
+    struct SwViewShell
+    {
+        int* GetWin();
+        int* Imp();
+    };
+    struct RenderContextGuard
+    // expected-error@-1 {{write m_pShell [loplugin:unusedfields]}}
+    // expected-error@-2 {{read m_pShell [loplugin:unusedfields]}}
+    {
+        SwViewShell* m_pShell;
+
+        RenderContextGuard(SwViewShell* pShell)
+            : m_pShell(pShell)
+        {
+            if (m_pShell->GetWin())
+            {
+                int* pDrawView(m_pShell->Imp());
+
+                if (nullptr != pDrawView)
+                {
+                    FindPageWindow(*m_pShell->GetWin());
+                }
+            }
+        }
+
+        void FindPageWindow(int x);
+    };
+};
+
+namespace WriteOnlyAnalysis4
+{
+    struct ImplTabCtrlData
+    // expected-error@-1 {{read maLayoutLineToPageId [loplugin:unusedfields]}}
+    // expected-error@-2 {{outside maLayoutLineToPageId [loplugin:unusedfields]}}
+    {
+        std::map< int, int > maLayoutLineToPageId;
+    };
+    class TabControl
+    // expected-error@-1 {{read mpTabCtrlData [loplugin:unusedfields]}}
+    // expected-error@-2 {{outside-constructor mpTabCtrlData [loplugin:unusedfields]}}
+    {
+        std::unique_ptr<ImplTabCtrlData> mpTabCtrlData;
+
+        void foo(int nLine, int& rPageId)
+        {
+            rPageId = mpTabCtrlData->maLayoutLineToPageId[ nLine ];
+        }
+    };
+}
+
+namespace WriteOnlyAnalysis5
+{
+    struct ImplTabCtrlData
+    // expected-error@-1 {{read maLayoutLineToPageId [loplugin:unusedfields]}}
+    // expected-error@-2 {{write maLayoutLineToPageId [loplugin:unusedfields]}}
+    // expected-error@-3 {{outside maLayoutLineToPageId [loplugin:unusedfields]}}
+    {
+        std::map< int, int > maLayoutLineToPageId;
+    };
+    class TabControl
+    // expected-error@-1 {{read mpTabCtrlData [loplugin:unusedfields]}}
+    // expected-error@-2 {{outside-constructor mpTabCtrlData [loplugin:unusedfields]}}
+    {
+        std::unique_ptr<ImplTabCtrlData> mpTabCtrlData;
+
+        void foo(int nLine, int nPageId)
+        {
+            mpTabCtrlData->maLayoutLineToPageId[ nLine ] = nPageId;
+        }
+    };
+}
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */