git.sesse.net Git - casparcg/blob - shell/generate_docs.cpp

   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 #include "included_modules.h"
  23
  24 #include <common/env.h>
  25 #include <common/log.h>
  26
  27 #include <core/producer/media_info/in_memory_media_info_repository.h>
  28 #include <core/help/help_repository.h>
  29 #include <core/help/help_sink.h>
  30 #include <core/help/util.h>
  31 #include <core/producer/text/text_producer.h>
  32
  33 #include <protocol/amcp/amcp_command_repository.h>
  34 #include <protocol/amcp/AMCPCommandsImpl.h>
  35
  36 #include <boost/filesystem/fstream.hpp>
  37
  38 #include <iostream>
  39 #include <sstream>
  40
  41 using namespace caspar;
  42
  43 static const int WIDTH = 150;
  44
  45 class mediawiki_paragraph_builder : public core::paragraph_builder
  46 {
  47         std::wostringstream     out_;
  48         std::wostream&          commit_to_;
  49 public:
  50         mediawiki_paragraph_builder(std::wostream& out)
  51                 : commit_to_(out)
  52         {
  53         }
  54
  55         ~mediawiki_paragraph_builder()
  56         {
  57                 commit_to_ << core::wordwrap(out_.str(), WIDTH) << std::endl;
  58         }
  59
  60         spl::shared_ptr<paragraph_builder> text(std::wstring text) override
  61         {
  62                 out_ << std::move(text);
  63                 return shared_from_this();
  64         };
  65
  66         spl::shared_ptr<paragraph_builder> code(std::wstring text) override
  67         {
  68                 out_ << L"<code>" << std::move(text) << L"</code>";
  69                 return shared_from_this();
  70         };
  71
  72         spl::shared_ptr<paragraph_builder> strong(std::wstring text) override
  73         {
  74                 out_ << L"'''" << std::move(text) << L"'''";
  75                 return shared_from_this();
  76         };
  77
  78         spl::shared_ptr<paragraph_builder> see(std::wstring item) override
  79         {
  80                 out_ << L"[[#" << item << L"|" << item << L"]]";
  81                 return shared_from_this();
  82         };
  83
  84         spl::shared_ptr<paragraph_builder> url(std::wstring url, std::wstring name) override
  85         {
  86                 out_ << L"[" << std::move(url) << L" " << std::move(name) << L"]";
  87                 return shared_from_this();
  88         };
  89 };
  90
  91 class mediawiki_definition_list_builder : public core::definition_list_builder
  92 {
  93         std::wostream& out_;
  94 public:
  95         mediawiki_definition_list_builder(std::wostream& out)
  96                 : out_(out)
  97         {
  98         }
  99
 100         ~mediawiki_definition_list_builder()
 101         {
 102                 out_ << std::endl;
 103         }
 104
 105         spl::shared_ptr<definition_list_builder> item(std::wstring term, std::wstring description) override
 106         {
 107                 out_ << L"; <code>" << term << L"</code>\n";
 108                 out_ << L": " << description << L"\n";
 109
 110                 return shared_from_this();
 111         };
 112 };
 113
 114 class mediawiki_help_sink : public core::help_sink
 115 {
 116         std::wostream& out_;
 117 public:
 118         mediawiki_help_sink(std::wostream& out)
 119                 : out_(out)
 120         {
 121         }
 122
 123         void start_section(std::wstring title)
 124         {
 125                 out_ << L"=" << title << L"=\n" << std::endl;
 126         }
 127
 128         void syntax(const std::wstring& syntax) override
 129         {
 130                 out_ << L"Syntax:\n";
 131                 out_ << core::indent(core::wordwrap(syntax, WIDTH - 1), L" ") << std::endl;
 132         }
 133
 134         spl::shared_ptr<core::paragraph_builder> para() override
 135         {
 136                 return spl::make_shared<mediawiki_paragraph_builder>(out_);
 137         }
 138
 139         spl::shared_ptr<core::definition_list_builder> definitions() override
 140         {
 141                 return spl::make_shared<mediawiki_definition_list_builder>(out_);
 142         }
 143
 144         void example(const std::wstring& code, const std::wstring& caption) override
 145         {
 146                 out_ << core::indent(core::wordwrap(code, WIDTH - 1), L" ");
 147
 148                 if (!caption.empty())
 149                         out_ << core::wordwrap(L"..." + caption, WIDTH - 1);
 150
 151                 out_ << std::endl;
 152         }
 153 private:
 154         void begin_item(const std::wstring& name) override
 155         {
 156                 out_ << L"==" << name << L"==\n" << std::endl;
 157         }
 158 };
 159
 160 void generate_amcp_commands_help(const core::help_repository& help_repo)
 161 {
 162         boost::filesystem::wofstream file(L"amcp_commands_help.wiki");
 163         mediawiki_help_sink sink(file);
 164
 165         auto print_section = [&](std::wstring title)
 166         {
 167                 sink.start_section(title);
 168                 help_repo.help({ L"AMCP", title }, sink);
 169         };
 170
 171         print_section(L"Basic Commands");
 172         print_section(L"Data Commands");
 173         print_section(L"Template Commands");
 174         print_section(L"Mixer Commands");
 175         print_section(L"Thumbnail Commands");
 176         print_section(L"Query Commands");
 177         file.flush();
 178 }
 179
 180 void generate_producers_help(const core::help_repository& help_repo)
 181 {
 182         boost::filesystem::wofstream file(L"producers_help.wiki");
 183         mediawiki_help_sink sink(file);
 184
 185         sink.start_section(L"Producers (Input Modules)");
 186         help_repo.help({ L"producer" }, sink);
 187
 188         file.flush();
 189 }
 190
 191 void generate_consumers_help(const core::help_repository& help_repo)
 192 {
 193         boost::filesystem::wofstream file(L"consumers_help.wiki");
 194         mediawiki_help_sink sink(file);
 195
 196         sink.start_section(L"Consumers (Output Modules)");
 197         help_repo.help({ L"consumer" }, sink);
 198
 199         file.flush();
 200 }
 201
 202 int main(int argc, char** argv)
 203 {
 204         if (intercept_command_line_args(argc, argv))
 205         {
 206                 return 0;
 207         }
 208
 209         env::configure(L"casparcg.config");
 210         spl::shared_ptr<core::system_info_provider_repository> system_info_provider_repo;
 211         spl::shared_ptr<core::cg_producer_registry> cg_registry;
 212         auto media_info_repo = core::create_in_memory_media_info_repository();
 213         spl::shared_ptr<core::help_repository> help_repo;
 214         auto producer_registry = spl::make_shared<core::frame_producer_registry>(help_repo);
 215         auto consumer_registry = spl::make_shared<core::frame_consumer_registry>(help_repo);
 216         std::promise<bool> shutdown_server_now;
 217         protocol::amcp::amcp_command_repository repo(
 218                         { },
 219                         nullptr,
 220                         media_info_repo,
 221                         system_info_provider_repo,
 222                         cg_registry,
 223                         help_repo,
 224                         producer_registry,
 225                         consumer_registry,
 226                         nullptr,
 227                         shutdown_server_now);
 228
 229         protocol::amcp::register_commands(repo);
 230
 231         core::module_dependencies dependencies(system_info_provider_repo, cg_registry, media_info_repo, producer_registry, consumer_registry);
 232         initialize_modules(dependencies);
 233         core::text::init(dependencies);
 234
 235         generate_amcp_commands_help(*help_repo);
 236         generate_producers_help(*help_repo);
 237         generate_consumers_help(*help_repo);
 238
 239         uninitialize_modules();
 240
 241         return 0;
 242 }