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 #ifndef INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_INC_DP_DEPENDENCIES_HXX
  21 #define INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_INC_DP_DEPENDENCIES_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <com/sun/star/uno/Reference.hxx>
  26 #include <com/sun/star/uno/Sequence.hxx>
  27 #include "dp_misc_api.hxx"
  28
  29 /// @HTML
  30
  31 namespace com { namespace sun { namespace star { namespace xml { namespace dom {
  32     class XElement;
  33 } } } } }
  34 namespace dp_misc { class DescriptionInfoset; }
  35
  36 namespace dp_misc {
  37
  38 /**
  39    Dependency handling.
  40 */
  41 namespace Dependencies {
  42     /**
  43        Check for unsatisfied dependencies.
  44
  45        @param infoset
  46        the infoset containing the dependencies to check
  47
  48        @return
  49        a list of the unsatisfied dependencies from <code>infoset</code> (in no
  50        specific order)
  51     */
  52     DESKTOP_DEPLOYMENTMISC_DLLPUBLIC css::uno::Sequence<
  53         css::uno::Reference< css::xml::dom::XElement > >
  54     check(dp_misc::DescriptionInfoset const & infoset);
  55
  56     /**
  57        Obtain the (human-readable) error message of a failed dependency.
  58
  59        @param dependency
  60        a dependency represented as a non-null XML element
  61
  62        @return
  63        the name of the dependency; will never be empty, as a localized
  64        &ldquo;unknown&rdquo; is substituted for an empty/missing name
  65     */
  66     DESKTOP_DEPLOYMENTMISC_DLLPUBLIC OUString getErrorText(
  67         css::uno::Reference< css::xml::dom::XElement >
  68             const & dependency);
  69 }
  70
  71 }
  72
  73 #endif
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */