desktop/source/deployment/inc/dp_dependencies.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <sal/config.h>
  23
  24 #include <com/sun/star/uno/Reference.hxx>
  25 #include <com/sun/star/uno/Sequence.hxx>
  26 #include "dp_misc_api.hxx"
  27
  28 /// @HTML
  29
  30 namespace com::sun::star::xml::dom {
  31     class XElement;
  32 }
  33 namespace dp_misc { class DescriptionInfoset; }
  34
  35 namespace dp_misc {
  36
  37 /**
  38    Dependency handling.
  39 */
  40 namespace Dependencies {
  41     /**
  42        Check for unsatisfied dependencies.
  43
  44        @param infoset
  45        the infoset containing the dependencies to check
  46
  47        @return
  48        a list of the unsatisfied dependencies from <code>infoset</code> (in no
  49        specific order)
  50     */
  51     DESKTOP_DEPLOYMENTMISC_DLLPUBLIC css::uno::Sequence<
  52         css::uno::Reference< css::xml::dom::XElement > >
  53     check(dp_misc::DescriptionInfoset const & infoset);
  54
  55     /**
  56        Obtain the (human-readable) error message of a failed dependency.
  57
  58        @param dependency
  59        a dependency represented as a non-null XML element
  60
  61        @return
  62        the name of the dependency; will never be empty, as a localized
  63        &ldquo;unknown&rdquo; is substituted for an empty/missing name
  64     */
  65     DESKTOP_DEPLOYMENTMISC_DLLPUBLIC OUString getErrorText(
  66         css::uno::Reference< css::xml::dom::XElement >
  67             const & dependency);
  68 }
  69
  70 }
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */