Logo ROOT  
Reference Guide
RWebDisplayHandle.hxx
Go to the documentation of this file.
1// Author: Sergey Linev <s.linev@gsi.de>
2// Date: 2018-10-17
3// Warning: This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is welcome!
4
5/*************************************************************************
6 * Copyright (C) 1995-2019, Rene Brun and Fons Rademakers. *
7 * All rights reserved. *
8 * *
9 * For the licensing terms see $ROOTSYS/LICENSE. *
10 * For the list of contributors see $ROOTSYS/README/CREDITS. *
11 *************************************************************************/
12
13#ifndef ROOT7_RWebDisplayHandle
14#define ROOT7_RWebDisplayHandle
15
17
18#include <string>
19#include <map>
20#include <memory>
21
22namespace ROOT {
23namespace Experimental {
24
26
27 std::string fUrl; ///!< URL used to launch display
28
29 std::string fContent; ///!< page content
30
31protected:
32
33 class Creator {
34 public:
35 virtual std::unique_ptr<RWebDisplayHandle> Display(const RWebDisplayArgs &args) = 0;
36 virtual bool IsActive() const { return true; }
37 virtual ~Creator() = default;
38 };
39
40 class BrowserCreator : public Creator {
41 protected:
42 std::string fProg; ///< browser executable
43 std::string fExec; ///< standard execute line
44 std::string fHeadlessExec; ///< headless execute line
45 std::string fBatchExec; ///< batch execute line
46
47 void TestProg(const std::string &nexttry, bool check_std_paths = false);
48
49 virtual void ProcessGeometry(std::string &, const RWebDisplayArgs &) {}
50 virtual std::string MakeProfile(std::string &, bool) { return ""; }
51
52 public:
53
54 BrowserCreator(bool custom = true, const std::string &exec = "");
55
56 std::unique_ptr<RWebDisplayHandle> Display(const RWebDisplayArgs &args) override;
57
58 virtual ~BrowserCreator() = default;
59 };
60
62 bool fEdge{false};
63 std::string fEnvPrefix; // rc parameters prefix
64 public:
65 ChromeCreator(bool is_edge = false);
66 virtual ~ChromeCreator() = default;
67 bool IsActive() const override { return !fProg.empty(); }
68 void ProcessGeometry(std::string &, const RWebDisplayArgs &args) override;
69 std::string MakeProfile(std::string &exec, bool) override;
70 };
71
73 public:
75 virtual ~FirefoxCreator() = default;
76 bool IsActive() const override { return !fProg.empty(); }
77 std::string MakeProfile(std::string &exec, bool batch) override;
78 };
79
80 static std::map<std::string, std::unique_ptr<Creator>> &GetMap();
81
82 static std::unique_ptr<Creator> &FindCreator(const std::string &name, const std::string &libname = "");
83
84public:
85
86 /// constructor
87 RWebDisplayHandle(const std::string &url) : fUrl(url) {}
88
89 /// required virtual destructor for correct cleanup at the end
90 virtual ~RWebDisplayHandle() = default;
91
92 /// returns url of start web display
93 const std::string &GetUrl() const { return fUrl; }
94
95 /// set content
96 void SetContent(const std::string &cont) { fContent = cont; }
97 /// get content
98 const std::string &GetContent() const { return fContent; }
99
100 static std::unique_ptr<RWebDisplayHandle> Display(const RWebDisplayArgs &args);
101
102 static bool DisplayUrl(const std::string &url);
103
104 static bool ProduceImage(const std::string &fname, const std::string &json, int width = 800, int height = 600);
105};
106
107}
108}
109
110#endif
Option_t Option_t width
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t height
char name[80]
Definition: TGX11.cxx:110
Holds different arguments for starting browser with RWebDisplayHandle::Display() method.
virtual std::string MakeProfile(std::string &, bool)
std::unique_ptr< RWebDisplayHandle > Display(const RWebDisplayArgs &args) override
Display given URL in web browser.
virtual void ProcessGeometry(std::string &, const RWebDisplayArgs &)
void TestProg(const std::string &nexttry, bool check_std_paths=false)
Check if browser executable exists and can be used.
BrowserCreator(bool custom=true, const std::string &exec="")
Class to handle starting of web-browsers like Chrome or Firefox.
void ProcessGeometry(std::string &, const RWebDisplayArgs &args) override
Replace $geometry placeholder with geometry settings Also RWebDisplayArgs::GetExtraArgs() are appende...
std::string MakeProfile(std::string &exec, bool) override
Handle profile argument.
virtual std::unique_ptr< RWebDisplayHandle > Display(const RWebDisplayArgs &args)=0
std::string MakeProfile(std::string &exec, bool batch) override
Create Firefox profile to run independent browser window.
Handle of created web-based display Depending from type of web display, holds handle of started brows...
static std::map< std::string, std::unique_ptr< Creator > > & GetMap()
Static holder of registered creators of web displays.
static bool ProduceImage(const std::string &fname, const std::string &json, int width=800, int height=600)
Produce image file using JSON data as source Invokes JSROOT drawing functionality in headless browser...
const std::string & GetUrl() const
returns url of start web display
RWebDisplayHandle(const std::string &url)
constructor
void SetContent(const std::string &cont)
set content
std::string fContent
!< URL used to launch display
const std::string & GetContent() const
get content
virtual ~RWebDisplayHandle()=default
required virtual destructor for correct cleanup at the end
static bool DisplayUrl(const std::string &url)
Display provided url in configured web browser.
static std::unique_ptr< RWebDisplayHandle > Display(const RWebDisplayArgs &args)
Create web display.
static std::unique_ptr< Creator > & FindCreator(const std::string &name, const std::string &libname="")
Search for specific browser creator If not found, try to add one.
This file contains a specialised ROOT message handler to test for diagnostic in unit tests.
basic_json<> json
Definition: REveElement.hxx:62