/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * 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/. * */ #include #include #include #include "DevToolsStrings.hrc" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace css; namespace { // returns a name of the object, if available OUString lclGetNamed(uno::Reference const& xObject) { uno::Reference xNamed(xObject, uno::UNO_QUERY); if (!xNamed.is()) return OUString(); return xNamed->getName(); } /** DocumentModelTreeEntry is an object "attached" to a tree node. * * It represents an object that is "attached" to the tree view an is * responsible to provide the UNO object associated with the current * node and on demand create and fill the children of the said node. */ class DocumentModelTreeEntry { protected: OUString maString; css::uno::Reference mxObject; public: DocumentModelTreeEntry(OUString aString, css::uno::Reference xObject) : maString(std::move(aString)) , mxObject(std::move(xObject)) { } virtual ~DocumentModelTreeEntry() {} /// the node string shown in the tree view OUString& getString() { return maString; } /// should show the expander for the tree view node virtual bool shouldShowExpander() { return false; } /// The main UNO object for this entry virtual css::uno::Reference getMainObject() { return mxObject; } /// Create and fill the children to the parent tree view node. virtual void fill(std::unique_ptr& /*pDocumentModelTree*/, weld::TreeIter const& /*rParent*/) { } }; // append an entry to a input TreeView to a parent void lclAppendToParentEntry(const std::unique_ptr& rTree, weld::TreeIter const& rParent, DocumentModelTreeEntry* pEntry) { OUString sId(weld::toId(pEntry)); OUString const& rString = pEntry->getString(); rTree->insert(&rParent, -1, &rString, &sId, nullptr, nullptr, pEntry->shouldShowExpander(), nullptr); } // append a root entry to a input TreeView void lclAppend(const std::unique_ptr& rTree, DocumentModelTreeEntry* pEntry) { OUString sId(weld::toId(pEntry)); OUString const& rString = pEntry->getString(); rTree->insert(nullptr, -1, &rString, &sId, nullptr, nullptr, pEntry->shouldShowExpander(), nullptr); } /** Entry that represents a object, which implements a XNameAccess */ class NameAccessTreeEntry : public DocumentModelTreeEntry { protected: NameAccessTreeEntry(OUString const& rString, uno::Reference const& xObject) : DocumentModelTreeEntry(rString, xObject) { } bool shouldShowExpander() override { uno::Reference xNameAccess(getMainObject(), uno::UNO_QUERY); return xNameAccess.is() && xNameAccess->getElementNames().getLength() > 0; } /// A generic fill when the UNO object implements XNameAccess interface void fill(std::unique_ptr& pDocumentModelTree, weld::TreeIter const& rParent) override { uno::Reference xNameAccess(getMainObject(), uno::UNO_QUERY); xNameAccess.set(getMainObject(), uno::UNO_QUERY); if (!xNameAccess.is()) return; const uno::Sequence aNames = xNameAccess->getElementNames(); for (auto const& rName : aNames) { uno::Reference xObject(xNameAccess->getByName(rName), uno::UNO_QUERY); auto pEntry = std::make_unique(rName, xObject); lclAppendToParentEntry(pDocumentModelTree, rParent, pEntry.release()); } } }; /** Entry that represents the document root object */ class DocumentRootEntry : public DocumentModelTreeEntry { public: DocumentRootEntry(OUString const& rString, uno::Reference const& xObject) : DocumentModelTreeEntry(rString, xObject) { } bool shouldShowExpander() override { return false; } }; /** Represents a paragraph object (XParagraph) */ class ParagraphEntry : public DocumentModelTreeEntry { public: ParagraphEntry(OUString const& rString, css::uno::Reference const& xObject) : DocumentModelTreeEntry(rString, xObject) { } bool shouldShowExpander() override { uno::Reference xEnumAccess(getMainObject(), uno::UNO_QUERY); if (!xEnumAccess.is()) return false; auto xTextPortions = xEnumAccess->createEnumeration(); if (!xTextPortions.is()) return false; return xTextPortions->hasMoreElements(); } void fill(std::unique_ptr& pDocumentModelTree, weld::TreeIter const& rParent) override { uno::Reference xEnumAccess(getMainObject(), uno::UNO_QUERY); if (!xEnumAccess.is()) return; uno::Reference xTextPortions = xEnumAccess->createEnumeration(); if (!xTextPortions.is()) return; for (sal_Int32 i = 0; xTextPortions->hasMoreElements(); i++) { uno::Reference const xTextPortion(xTextPortions->nextElement(), uno::UNO_QUERY); OUString aString = lclGetNamed(xTextPortion); if (aString.isEmpty()) { OUString aNumber = OUString::number(i + 1); aString = SfxResId(STR_TEXT_PORTION).replaceFirst("%1", aNumber); } auto pEntry = std::make_unique(aString, xTextPortion); lclAppendToParentEntry(pDocumentModelTree, rParent, pEntry.release()); } } }; /** Represents a list of paragraphs */ class ParagraphsEntry : public DocumentModelTreeEntry { public: ParagraphsEntry(OUString const& rString, css::uno::Reference const& xObject) : DocumentModelTreeEntry(rString, xObject) { } css::uno::Reference getMainObject() override { uno::Reference xDocument(mxObject, uno::UNO_QUERY); if (!xDocument.is()) return mxObject; return xDocument->getText()->getText(); } bool shouldShowExpander() override { uno::Reference xEnumAccess(getMainObject(), uno::UNO_QUERY); if (!xEnumAccess.is()) return false; auto xParagraphEnum = xEnumAccess->createEnumeration(); if (!xParagraphEnum.is()) return false; return xParagraphEnum->hasMoreElements(); } void fill(std::unique_ptr& pDocumentModelTree, weld::TreeIter const& rParent) override { uno::Reference xEnumAccess(getMainObject(), uno::UNO_QUERY); if (!xEnumAccess.is()) return; uno::Reference xParagraphEnum = xEnumAccess->createEnumeration(); if (!xParagraphEnum.is()) return; for (sal_Int32 i = 0; xParagraphEnum->hasMoreElements(); i++) { uno::Reference const xParagraph(xParagraphEnum->nextElement(), uno::UNO_QUERY); OUString aString = lclGetNamed(xParagraph); if (aString.isEmpty()) { aString = SfxResId(STR_PARAGRAPH).replaceFirst("%1", OUString::number(i + 1)); } auto pEntry = std::make_unique(aString, xParagraph); lclAppendToParentEntry(pDocumentModelTree, rParent, pEntry.release()); } } }; /** Represents a list of shapes */ class ShapesEntry : public DocumentModelTreeEntry { public: ShapesEntry(OUString const& rString, css::uno::Reference const& xObject) : DocumentModelTreeEntry(rString, xObject) { } css::uno::Reference getMainObject() override { uno::Reference xSupplier(mxObject, uno::UNO_QUERY); if (!xSupplier.is()) return mxObject; return xSupplier->getDrawPage(); } bool shouldShowExpander() override { uno::Reference xShapes(getMainObject(), uno::UNO_QUERY); return xShapes.is() && xShapes->getCount() > 0; } void fill(std::unique_ptr& pDocumentModelTree, weld::TreeIter const& rParent) override { uno::Reference xShapes(getMainObject(), uno::UNO_QUERY); if (!xShapes.is()) return; for (sal_Int32 nIndexShapes = 0; nIndexShapes < xShapes->getCount(); ++nIndexShapes) { uno::Reference xShape(xShapes->getByIndex(nIndexShapes), uno::UNO_QUERY); OUString aShapeName = lclGetNamed(xShape); if (aShapeName.isEmpty()) { aShapeName = SfxResId(STR_SHAPE).replaceFirst("%1", OUString::number(nIndexShapes + 1)); } auto pEntry = std::make_unique(aShapeName, xShape); lclAppendToParentEntry(pDocumentModelTree, rParent, pEntry.release()); } } }; /** Represents a list of tables */ class TablesEntry : public NameAccessTreeEntry { public: TablesEntry(OUString const& rString, css::uno::Reference const& xObject) : NameAccessTreeEntry(rString, xObject) { } css::uno::Reference getMainObject() override { uno::Reference xSupplier(mxObject, uno::UNO_QUERY); if (!xSupplier.is()) return mxObject; return xSupplier->getTextTables(); } }; /** Represents a list of frames */ class FramesEntry : public NameAccessTreeEntry { public: FramesEntry(OUString const& rString, css::uno::Reference const& xObject) : NameAccessTreeEntry(rString, xObject) { } css::uno::Reference getMainObject() override { uno::Reference xSupplier(mxObject, uno::UNO_QUERY); if (!xSupplier.is()) return mxObject; return xSupplier->getTextFrames(); } }; /** Represents a list of writer graphic objects */ class WriterGraphicObjectsEntry : public NameAccessTreeEntry { public: WriterGraphicObjectsEntry(OUString const& rString, css::uno::Reference const& xObject) : NameAccessTreeEntry(rString, xObject) { } css::uno::Reference getMainObject() override { uno::Reference xSupplier(mxObject, uno::UNO_QUERY); if (!xSupplier.is()) return mxObject; return xSupplier->getGraphicObjects(); } }; /** Represents a list of writer embedded (OLE) objects */ class EmbeddedObjectsEntry : public NameAccessTreeEntry { public: EmbeddedObjectsEntry(OUString const& rString, css::uno::Reference const& xObject) : NameAccessTreeEntry(rString, xObject) { } css::uno::Reference getMainObject() override { uno::Reference xSupplier(mxObject, uno::UNO_QUERY); if (!xSupplier.is()) return mxObject; return xSupplier->getEmbeddedObjects(); } }; /** Represents a style family, which contains a list of styles */ class StylesFamilyEntry : public NameAccessTreeEntry { public: StylesFamilyEntry(OUString const& rString, css::uno::Reference const& xObject) : NameAccessTreeEntry(rString, xObject) { } }; /** Represents a list of style families */ class StylesFamiliesEntry : public DocumentModelTreeEntry { public: StylesFamiliesEntry(OUString const& rString, css::uno::Reference const& xObject) : DocumentModelTreeEntry(rString, xObject) { } css::uno::Reference getMainObject() override { uno::Reference xSupplier(mxObject, uno::UNO_QUERY); if (!xSupplier.is()) return mxObject; return xSupplier->getStyleFamilies(); } bool shouldShowExpander() override { uno::Reference xStyleFamilies(getMainObject(), uno::UNO_QUERY); return xStyleFamilies.is() && xStyleFamilies->getElementNames().getLength() > 0; } void fill(std::unique_ptr& pDocumentModelTree, weld::TreeIter const& rParent) override { uno::Reference xStyleFamilies(getMainObject(), uno::UNO_QUERY); if (!xStyleFamilies.is()) return; const uno::Sequence aNames = xStyleFamilies->getElementNames(); for (auto const& rFamilyName : aNames) { uno::Reference xStyleFamily(xStyleFamilies->getByName(rFamilyName), uno::UNO_QUERY); auto pStylesFamilyEntry = std::make_unique(rFamilyName, xStyleFamily); lclAppendToParentEntry(pDocumentModelTree, rParent, pStylesFamilyEntry.release()); } } }; /** Represents a list of pages */ class PagesEntry : public DocumentModelTreeEntry { public: PagesEntry(OUString const& rString, css::uno::Reference const& xObject) : DocumentModelTreeEntry(rString, xObject) { } css::uno::Reference getMainObject() override { uno::Reference xSupplier(mxObject, uno::UNO_QUERY); if (!xSupplier.is()) return mxObject; return xSupplier->getDrawPages(); } bool shouldShowExpander() override { uno::Reference xDrawPages(getMainObject(), uno::UNO_QUERY); return xDrawPages.is() && xDrawPages->getCount() > 0; } void fill(std::unique_ptr& pDocumentModelTree, weld::TreeIter const& rParent) override { uno::Reference xDrawPages(getMainObject(), uno::UNO_QUERY); for (sal_Int32 i = 0; i < xDrawPages->getCount(); ++i) { uno::Reference xPage(xDrawPages->getByIndex(i), uno::UNO_QUERY); if (!xPage.is()) continue; OUString aPageString = lclGetNamed(xPage); if (aPageString.isEmpty()) aPageString = SfxResId(STR_PAGE).replaceFirst("%1", OUString::number(i + 1)); auto pShapesEntry = std::make_unique(aPageString, xPage); lclAppendToParentEntry(pDocumentModelTree, rParent, pShapesEntry.release()); } } }; /** Represents a list of (Impress) slides */ class SlidesEntry : public DocumentModelTreeEntry { public: SlidesEntry(OUString const& rString, css::uno::Reference const& xObject) : DocumentModelTreeEntry(rString, xObject) { } css::uno::Reference getMainObject() override { uno::Reference xSupplier(mxObject, uno::UNO_QUERY); if (!xSupplier.is()) return mxObject; return xSupplier->getDrawPages(); } bool shouldShowExpander() override { uno::Reference xDrawPages(getMainObject(), uno::UNO_QUERY); return xDrawPages.is() && xDrawPages->getCount() > 0; } void fill(std::unique_ptr& pDocumentModelTree, weld::TreeIter const& rParent) override { uno::Reference xDrawPages(getMainObject(), uno::UNO_QUERY); for (sal_Int32 i = 0; i < xDrawPages->getCount(); ++i) { uno::Reference xPage(xDrawPages->getByIndex(i), uno::UNO_QUERY); if (!xPage.is()) continue; OUString aPageString = lclGetNamed(xPage); if (aPageString.isEmpty()) aPageString = SfxResId(STR_SLIDE).replaceFirst("%1", OUString::number(i + 1)); auto pShapesEntry = std::make_unique(aPageString, xPage); lclAppendToParentEntry(pDocumentModelTree, rParent, pShapesEntry.release()); } } }; /** Represents a list of (Impress) master slides */ class MasterSlidesEntry : public DocumentModelTreeEntry { public: MasterSlidesEntry(OUString const& rString, css::uno::Reference const& xObject) : DocumentModelTreeEntry(rString, xObject) { } css::uno::Reference getMainObject() override { uno::Reference xSupplier(mxObject, uno::UNO_QUERY); if (!xSupplier.is()) return mxObject; return xSupplier->getMasterPages(); } bool shouldShowExpander() override { uno::Reference xDrawPages(getMainObject(), uno::UNO_QUERY); return xDrawPages.is() && xDrawPages->getCount() > 0; } void fill(std::unique_ptr& pDocumentModelTree, weld::TreeIter const& rParent) override { uno::Reference xDrawPages(getMainObject(), uno::UNO_QUERY); for (sal_Int32 i = 0; i < xDrawPages->getCount(); ++i) { uno::Reference xPage(xDrawPages->getByIndex(i), uno::UNO_QUERY); if (!xPage.is()) continue; OUString aPageString = lclGetNamed(xPage); if (aPageString.isEmpty()) { aPageString = SfxResId(STR_MASTER_SLIDE).replaceFirst("%1", OUString::number(i + 1)); } auto pShapesEntry = std::make_unique(aPageString, xPage); lclAppendToParentEntry(pDocumentModelTree, rParent, pShapesEntry.release()); } } }; /** Represents a list of charts */ class ChartsEntry : public NameAccessTreeEntry { public: ChartsEntry(OUString const& rString, css::uno::Reference const& xObject) : NameAccessTreeEntry(rString, xObject) { } css::uno::Reference getMainObject() override { uno::Reference xSupplier(mxObject, uno::UNO_QUERY); if (!xSupplier.is()) return mxObject; return xSupplier->getCharts(); } void fill(std::unique_ptr& pDocumentModelTree, weld::TreeIter const& rParent) override { uno::Reference xCharts(getMainObject(), uno::UNO_QUERY); if (!xCharts.is()) return; NameAccessTreeEntry::fill(pDocumentModelTree, rParent); } }; /** Represents a list of pivot tables */ class PivotTablesEntry : public NameAccessTreeEntry { public: PivotTablesEntry(OUString const& rString, css::uno::Reference const& xObject) : NameAccessTreeEntry(rString, xObject) { } bool shouldShowExpander() override { return true; } css::uno::Reference getMainObject() override { uno::Reference xSupplier(mxObject, uno::UNO_QUERY); if (!xSupplier.is()) return mxObject; return xSupplier->getDataPilotTables(); } void fill(std::unique_ptr& pDocumentModelTree, weld::TreeIter const& rParent) override { uno::Reference xPivotTables(getMainObject(), uno::UNO_QUERY); if (!xPivotTables.is()) return; NameAccessTreeEntry::fill(pDocumentModelTree, rParent); } }; /** Represents a (Calc) sheet */ class SheetEntry : public DocumentModelTreeEntry { public: SheetEntry(OUString const& rString, css::uno::Reference const& xObject) : DocumentModelTreeEntry(rString, xObject) { } bool shouldShowExpander() override { return true; } void fill(std::unique_ptr& pDocumentModelTree, weld::TreeIter const& rParent) override { auto pShapesEntry = std::make_unique(SfxResId(STR_SHAPES_ENTRY), getMainObject()); lclAppendToParentEntry(pDocumentModelTree, rParent, pShapesEntry.release()); auto pChartsEntry = std::make_unique(SfxResId(STR_CHARTS_ENTRY), getMainObject()); lclAppendToParentEntry(pDocumentModelTree, rParent, pChartsEntry.release()); auto pPivotTablesEntry = std::make_unique(SfxResId(STR_PIVOT_TABLES_ENTRY), getMainObject()); lclAppendToParentEntry(pDocumentModelTree, rParent, pPivotTablesEntry.release()); } }; /** Represents a list of (Calc) sheet */ class SheetsEntry : public DocumentModelTreeEntry { public: SheetsEntry(OUString const& rString, css::uno::Reference const& xObject) : DocumentModelTreeEntry(rString, xObject) { } css::uno::Reference getMainObject() override { uno::Reference xSheetDocument(mxObject, uno::UNO_QUERY); if (!xSheetDocument.is()) return mxObject; return xSheetDocument->getSheets(); } bool shouldShowExpander() override { uno::Reference xIndexAccess(getMainObject(), uno::UNO_QUERY); return xIndexAccess.is() && xIndexAccess->getCount() > 0; } void fill(std::unique_ptr& pDocumentModelTree, weld::TreeIter const& rParent) override { uno::Reference xIndexAccesss(getMainObject(), uno::UNO_QUERY); if (!xIndexAccesss.is()) return; for (sal_Int32 i = 0; i < xIndexAccesss->getCount(); ++i) { uno::Reference xSheet(xIndexAccesss->getByIndex(i), uno::UNO_QUERY); OUString aString = lclGetNamed(xSheet); if (aString.isEmpty()) aString = SfxResId(STR_SHEET).replaceFirst("%1", OUString::number(i + 1)); auto pEntry = std::make_unique(aString, xSheet); lclAppendToParentEntry(pDocumentModelTree, rParent, pEntry.release()); } } }; } // end anonymous namespace DocumentModelTreeHandler::DocumentModelTreeHandler( std::unique_ptr& pDocumentModelTree, css::uno::Reference xDocument) : mpDocumentModelTree(pDocumentModelTree) , mxDocument(std::move(xDocument)) { mpDocumentModelTree->connect_expanding(LINK(this, DocumentModelTreeHandler, ExpandingHandler)); } uno::Reference DocumentModelTreeHandler::getObjectByID(OUString const& rID) { uno::Reference xObject; if (rID.isEmpty()) return xObject; auto* pEntry = weld::fromId(rID); return pEntry->getMainObject(); } void DocumentModelTreeHandler::clearAll() { // destroy all DocumentModelTreeEntries from the tree mpDocumentModelTree->all_foreach([this](weld::TreeIter& rEntry) { OUString sID = mpDocumentModelTree->get_id(rEntry); auto* pEntry = weld::fromId(sID); delete pEntry; return false; }); mpDocumentModelTree->clear(); } void DocumentModelTreeHandler::clearChildren(weld::TreeIter const& rParent) { bool bChild = false; do { bChild = mpDocumentModelTree->iter_has_child(rParent); if (bChild) { std::unique_ptr pChild = mpDocumentModelTree->make_iterator(&rParent); bChild = mpDocumentModelTree->iter_children(*pChild); if (bChild) { clearChildren(*pChild); OUString sID = mpDocumentModelTree->get_id(*pChild); auto* pEntry = weld::fromId(sID); delete pEntry; mpDocumentModelTree->remove(*pChild); } } } while (bChild); } void DocumentModelTreeHandler::dispose() { mpDocumentModelTree->all_foreach([this](weld::TreeIter& rEntry) { OUString sID = mpDocumentModelTree->get_id(rEntry); auto* pEntry = weld::fromId(sID); delete pEntry; return false; }); } IMPL_LINK(DocumentModelTreeHandler, ExpandingHandler, weld::TreeIter const&, rParent, bool) { OUString sID = mpDocumentModelTree->get_id(rParent); if (sID.isEmpty()) return true; clearChildren(rParent); auto* pEntry = weld::fromId(sID); pEntry->fill(mpDocumentModelTree, rParent); return true; } void DocumentModelTreeHandler::selectObject( css::uno::Reference const& xInterface) { mpDocumentModelTree->unselect_all(); mpDocumentModelTree->all_foreach([this, xInterface](weld::TreeIter& rEntry) { OUString sID = mpDocumentModelTree->get_id(rEntry); auto* pEntry = weld::fromId(sID); if (xInterface == pEntry->getMainObject()) { mpDocumentModelTree->select(rEntry); return true; } return false; }); } void DocumentModelTreeHandler::inspectDocument() { clearAll(); uno::Reference xDocumentServiceInfo(mxDocument, uno::UNO_QUERY_THROW); lclAppend(mpDocumentModelTree, new DocumentRootEntry(SfxResId(STR_DOCUMENT_ENTRY), mxDocument)); if (xDocumentServiceInfo->supportsService(u"com.sun.star.sheet.SpreadsheetDocument"_ustr)) { lclAppend(mpDocumentModelTree, new SheetsEntry(SfxResId(STR_SHEETS_ENTRY), mxDocument)); lclAppend(mpDocumentModelTree, new StylesFamiliesEntry(SfxResId(STR_STYLES_ENTRY), mxDocument)); } else if (xDocumentServiceInfo->supportsService( u"com.sun.star.presentation.PresentationDocument"_ustr)) { lclAppend(mpDocumentModelTree, new SlidesEntry(SfxResId(STR_SLIDES_ENTRY), mxDocument)); lclAppend(mpDocumentModelTree, new MasterSlidesEntry(SfxResId(STR_MASTER_SLIDES_ENTRY), mxDocument)); lclAppend(mpDocumentModelTree, new StylesFamiliesEntry(SfxResId(STR_STYLES_ENTRY), mxDocument)); } else if (xDocumentServiceInfo->supportsService(u"com.sun.star.drawing.DrawingDocument"_ustr)) { lclAppend(mpDocumentModelTree, new PagesEntry(SfxResId(STR_PAGES_ENTRY), mxDocument)); lclAppend(mpDocumentModelTree, new StylesFamiliesEntry(SfxResId(STR_STYLES_ENTRY), mxDocument)); } else if (xDocumentServiceInfo->supportsService(u"com.sun.star.text.TextDocument"_ustr) || xDocumentServiceInfo->supportsService(u"com.sun.star.text.WebDocument"_ustr)) { lclAppend(mpDocumentModelTree, new ParagraphsEntry(SfxResId(STR_PARAGRAPHS_ENTRY), mxDocument)); lclAppend(mpDocumentModelTree, new ShapesEntry(SfxResId(STR_SHAPES_ENTRY), mxDocument)); lclAppend(mpDocumentModelTree, new TablesEntry(SfxResId(STR_TABLES_ENTRY), mxDocument)); lclAppend(mpDocumentModelTree, new FramesEntry(SfxResId(STR_FRAMES_ENTRY), mxDocument)); lclAppend(mpDocumentModelTree, new WriterGraphicObjectsEntry(SfxResId(STR_GRAPHIC_OBJECTS_ENTRY), mxDocument)); lclAppend(mpDocumentModelTree, new EmbeddedObjectsEntry(SfxResId(STR_EMBEDDED_OBJECTS_ENTRY), mxDocument)); lclAppend(mpDocumentModelTree, new StylesFamiliesEntry(SfxResId(STR_STYLES_ENTRY), mxDocument)); } } /* vim:set shiftwidth=4 softtabstop=4 expandtab: */