git.sesse.net Git - casparcg/blob - core/help/help_repository.h

   1 /*
   2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
   3 *
   4 * This file is part of CasparCG (www.casparcg.com).
   5 *
   6 * CasparCG is free software: you can redistribute it and/or modify
   7 * it under the terms of the GNU General Public License as published by
   8 * the Free Software Foundation, either version 3 of the License, or
   9 * (at your option) any later version.
  10 *
  11 * CasparCG is distributed in the hope that it will be useful,
  12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 * GNU General Public License for more details.
  15 *
  16 * You should have received a copy of the GNU General Public License
  17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.
  18 *
  19 * Author: Helge Norberg, helge.norberg@svt.se
  20 */
  21
  22 #pragma once
  23
  24 #include "../fwd.h"
  25
  26 #include <common/memory.h>
  27
  28 #include <set>
  29 #include <vector>
  30 #include <functional>
  31 #include <utility>
  32
  33 namespace caspar { namespace core {
  34
  35 typedef std::function<void(core::help_sink&, const core::help_repository&)> help_item_describer;
  36
  37 class help_repository
  38 {
  39 public:
  40         help_repository();
  41         void register_item(std::set<std::wstring> tags, std::wstring name, help_item_describer describer); // Not thread safe
  42         void help(std::set<std::wstring> tags, help_sink& sink) const;
  43         void help(std::set<std::wstring> tags, std::wstring name, help_sink& sink) const;
  44 private:
  45         struct impl;
  46         spl::shared_ptr<impl> impl_;
  47 };
  48
  49 }}