CTK/Libs/PluginFramework/ctkPluginFrameworkUtil_p.h

/*=============================================================================

  Library: CTK

  Copyright (c) German Cancer Research Center,
    Division of Medical and Biological Informatics

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

=============================================================================*/

#ifndef CTKPLUGINFRAMEWORKUTIL_P_H
#define CTKPLUGINFRAMEWORKUTIL_P_H

#include <QMap>
#include <QStringList>
#include <QDir>

class ctkPluginFrameworkContext;

/**
 * \ingroup PluginFramework
 */
class ctkPluginFrameworkUtil
{
public:

  /**
   * Parse strings of format:
   *
   *   ENTRY (, ENTRY)*
   *   ENTRY = key (; key)* (; PARAM)*
   *   PARAM = attribute '=' value
   *   PARAM = directive ':=' value
   *
   * @param a Attribute being parsed
   * @param s String to parse
   * @param single If true, only allow one key per ENTRY
   * @param unique Only allow unique parameters for each ENTRY.
   * @param single_entry If true, only allow one ENTRY is allowed.
   * @return QMap<QString, QString> mapping attributes to values.
   * @exception std::invalid_argument If syntax error in input string.
   */
  static QList<QMap<QString, QStringList> > parseEntries(const QString& a, const QString& s,
                                                         bool single, bool unique, bool single_entry);

  static QString getFrameworkDir(ctkPluginFrameworkContext* ctx);

  /**
   * Check for local file storage directory.
   *
   * @param name local directory name.
   * @return A QDir object pointing to the directory. The directory is
   *         guaranteed to exist.
   * @throws std::runtime_error if there is no global framework storage
   *         directory or if the directory could not be created.
   */
  static QDir getFileStorage(ctkPluginFrameworkContext* ctx, const QString& name);

  /**
   * Remove a non-empty directory.
   *
   * @param dirName The directory to remove
   * @returns <code>true</code> on success, <code>false</code> otherwise.
   */
  static bool removeDir(const QString& dirName);
};

#endif // CTKPLUGINFRAMEWORKUTIL_P_H