A simple widget to visualise a set of example source files. More...

#include <ExampleSourceViewer.h>

Inheritance diagram for ExampleSourceViewer:

Public Member Functions
	ExampleSourceViewer (const std::string &deployPath, const std::string &examplesRoot, const std::string &examplesType)
	Constructor. More...

Public Member Functions inherited from Wt::WContainerWidget
	WContainerWidget ()

	~WContainerWidget ()

void	setLayout (std::unique_ptr< WLayout > layout)

Layout *	setLayout (std::unique_ptr< Layout > layout)

WLayout *	layout () const

virtual void	addWidget (std::unique_ptr< WWidget > widget)

Widget *	addWidget (std::unique_ptr< Widget > widget)

Widget *	addNew (Args &&...args)

virtual void	insertBefore (std::unique_ptr< WWidget > widget, WWidget *before)

Widget *	insertBefore (std::unique_ptr< Widget > widget, WWidget *before)

virtual void	insertWidget (int index, std::unique_ptr< WWidget > widget)

Widget *	insertWidget (int index, std::unique_ptr< Widget > widget)

Widget *	insertNew (int index, Args &&...args)

virtual std::unique_ptr< WWidget >	removeWidget (WWidget *widget) override

virtual void	clear ()

virtual int	indexOf (WWidget *widget) const

virtual WWidget *	widget (int index) const

virtual int	count () const

void	setContentAlignment (WFlags< AlignmentFlag > contentAlignment)

void	setPadding (const WLength &padding, WFlags< Side > sides=AllSides)

WLength	padding (Side side) const

WFlags< AlignmentFlag >	contentAlignment () const

void	setOverflow (Overflow overflow, WFlags< Orientation > orientation=(Orientation::Horizontal\|Orientation::Vertical))

void	setList (bool list, bool ordered=false)

bool	isList () const

bool	isUnorderedList () const

bool	isOrderedList () const

EventSignal< WScrollEvent > &	scrolled ()

int	scrollTop () const

int	scrollLeft () const

virtual std::unique_ptr< WWidget >	removeWidget (WWidget *widget)

std::unique_ptr< Widget >	removeWidget (Widget *widget)

Public Member Functions inherited from Wt::WInteractWidget
	WInteractWidget ()

EventSignal< WKeyEvent > &	keyWentDown ()

EventSignal< WKeyEvent > &	keyPressed ()

EventSignal< WKeyEvent > &	keyWentUp ()

EventSignal &	enterPressed ()

EventSignal &	escapePressed ()

EventSignal< WMouseEvent > &	clicked ()

EventSignal< WMouseEvent > &	doubleClicked ()

EventSignal< WMouseEvent > &	mouseWentDown ()

EventSignal< WMouseEvent > &	mouseWentUp ()

EventSignal< WMouseEvent > &	mouseWentOut ()

EventSignal< WMouseEvent > &	mouseWentOver ()

EventSignal< WMouseEvent > &	mouseMoved ()

EventSignal< WMouseEvent > &	mouseDragged ()

EventSignal< WMouseEvent > &	mouseWheel ()

EventSignal< WTouchEvent > &	touchStarted ()

EventSignal< WTouchEvent > &	touchEnded ()

EventSignal< WTouchEvent > &	touchMoved ()

EventSignal< WGestureEvent > &	gestureStarted ()

EventSignal< WGestureEvent > &	gestureChanged ()

EventSignal< WGestureEvent > &	gestureEnded ()

void	setDraggable (const std::string &mimeType, WWidget dragWidget=nullptr, bool isDragWidgetOnly=false, WObject sourceWidget=nullptr)

void	unsetDraggable ()

void	setMouseOverDelay (int delay)

int	mouseOverDelay () const

virtual void	setPopup (bool popup) override

virtual void	load () override

virtual bool	isEnabled () const override

Public Member Functions inherited from Wt::WWebWidget
	WWebWidget ()

virtual std::vector< WWidget * >	children () const override

Signal &	childrenChanged ()

virtual void	setPositionScheme (PositionScheme scheme) override

virtual PositionScheme	positionScheme () const override

virtual void	setOffsets (const WLength &offset, WFlags< Side > sides=AllSides) override

virtual WLength	offset (Side s) const override

virtual void	resize (const WLength &width, const WLength &height) override

virtual WLength	width () const override

virtual WLength	height () const override

virtual void	setMinimumSize (const WLength &width, const WLength &height) override

virtual WLength	minimumWidth () const override

virtual WLength	minimumHeight () const override

virtual void	setMaximumSize (const WLength &width, const WLength &height) override

virtual WLength	maximumWidth () const override

virtual WLength	maximumHeight () const override

virtual void	setLineHeight (const WLength &height) override

virtual WLength	lineHeight () const override

virtual void	setFloatSide (Side s) override

virtual Side	floatSide () const override

virtual void	setClearSides (WFlags< Side > sides) override

virtual WFlags< Side >	clearSides () const override

virtual void	setMargin (const WLength &margin, WFlags< Side > sides=AllSides) override

virtual WLength	margin (Side side) const override

virtual void	setHiddenKeepsGeometry (bool enabled) override

virtual bool	hiddenKeepsGeometry () const override

virtual void	setHidden (bool hidden, const WAnimation &animation=WAnimation()) override

virtual bool	isHidden () const override

virtual bool	isVisible () const override

virtual void	setDisabled (bool disabled) override

virtual bool	isDisabled () const override

virtual bool	isPopup () const override

virtual void	setInline (bool isInline) override

virtual bool	isInline () const override

virtual void	setDecorationStyle (const WCssDecorationStyle &style) override

virtual WCssDecorationStyle &	decorationStyle () override

virtual void	setStyleClass (const WString &styleClass) override

virtual WString	styleClass () const override

virtual void	addStyleClass (const WString &styleClass, bool force=false) override

virtual void	removeStyleClass (const WString &styleClass, bool force=false) override

virtual bool	hasStyleClass (const WString &styleClass) const override

virtual void	setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength()) override

virtual AlignmentFlag	verticalAlignment () const override

virtual WLength	verticalAlignmentLength () const override

virtual void	setToolTip (const WString &text, TextFormat textFormat=TextFormat::Plain) override

virtual void	setDeferredToolTip (bool enable, TextFormat textFormat=TextFormat::Plain) override

virtual WString	toolTip () const override

void	showToolTipOnHover (bool enable)

void	showToolTip ()

void	hideToolTip ()

virtual void	refresh () override

virtual void	setAttributeValue (const std::string &name, const WString &value) override

virtual WString	attributeValue (const std::string &name) const override

virtual void	setJavaScriptMember (const std::string &name, const std::string &value) override

virtual std::string	javaScriptMember (const std::string &name) const override

virtual void	callJavaScriptMember (const std::string &name, const std::string &args) override

virtual bool	loaded () const override

virtual void	setId (const std::string &id) override

virtual WWidget *	find (const std::string &name) override

virtual WWidget *	findById (const std::string &id) override

virtual void	setSelectable (bool selectable) override

virtual void	doJavaScript (const std::string &javascript) override

virtual const std::string	id () const override

void	setLoadLaterWhenInvisible (bool)

std::string	htmlTagName () const

void	setHtmlTagName (const std::string &tag)

virtual void	setCanReceiveFocus (bool enabled) override

virtual bool	canReceiveFocus () const override

virtual bool	setFirstFocus () override

virtual void	setFocus (bool focus) override

virtual bool	hasFocus () const override

virtual void	setTabIndex (int index) override

virtual int	tabIndex () const override

EventSignal &	blurred ()

EventSignal &	focussed ()

virtual bool	scrollVisibilityEnabled () const final override

virtual void	setScrollVisibilityEnabled (bool enabled) final override

virtual int	scrollVisibilityMargin () const final override

virtual void	setScrollVisibilityMargin (int margin) final override

virtual Signal< bool > &	scrollVisibilityChanged () final override

virtual bool	isScrollVisible () const final override

virtual void	setThemeStyleEnabled (bool enabled) final override

virtual bool	isThemeStyleEnabled () const final override

virtual void	setObjectName (const std::string &name) override

void	setFocus ()

virtual void	setFocus (bool focus)=0

Public Member Functions inherited from Wt::WWidget
virtual	~WWidget ()

WWidget *	parent () const

std::unique_ptr< Widget >	removeWidget (Widget *widget)

std::unique_ptr< WWidget >	removeFromParent ()

void	setWidth (const WLength &width)

void	setHeight (const WLength &height)

virtual void	positionAt (const WWidget *widget, Orientation orientation=Orientation::Vertical, WFlags< Orientation > adjustOrientations=AllOrientations)

virtual void	toggleStyleClass (const WString &styleClass, bool add, bool force=false)

std::string	jsRef () const

void	setFocus ()

virtual void	acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())

virtual void	stopAcceptDrops (const std::string &mimeType)

virtual void	htmlText (std::ostream &out)

bool	isRendered () const

void	hide ()

void	animateHide (const WAnimation &animation)

void	show ()

void	animateShow (const WAnimation &animation)

void	enable ()

void	disable ()

bool	layoutSizeAware () const

Public Member Functions inherited from Wt::WObject
void	addChild (std::unique_ptr< WObject > child)

Child *	addChild (std::unique_ptr< Child > child)

std::unique_ptr< WObject >	removeChild (WObject *child)

std::unique_ptr< Child >	removeChild (Child *child)

virtual std::string	objectName () const

void	resetLearnedSlots ()

void	resetLearnedSlot (void(T::*method)())

WStatelessSlot *	implementStateless (void(T::*method)())

WStatelessSlot *	implementStateless (void(T::method)(), void(T::undoMethod)())

void	isNotStateless ()

WStatelessSlot *	implementJavaScript (void(T::*method)(), const std::string &jsCode)

Public Member Functions inherited from Wt::Core::observable
	observable () noexcept

virtual	~observable ()

auto	bindSafe (void(C::*method)(Args...)) noexcept

auto	bindSafe (void(C::*method)(Args...) const) const noexcept

auto	bindSafe (const Function &function) noexcept

Private Member Functions
void	cppTraverseDir (WStandardItem *parent, const cpp17::filesystem::path &path)

void	javaTraverseDir (WStandardItem *parent, const cpp17::filesystem::path &path)

void	javaTraversePackages (WStandardItem *parent, const cpp17::filesystem::path &srcPath, const std::string packageName)

void	showFile ()
	Displayed the currently selected file. More...

void	handlePathChange ()

void	setExample (const std::string &exampleDir, const std::string &example)

Private Attributes
WTreeView *	exampleView_

SourceView *	sourceView_

std::string	deployPath_

std::string	examplesRoot_

std::string	examplesType_

std::shared_ptr< WStandardItemModel >	model_

Additional Inherited Members
Public Types inherited from Wt::WObject
typedef void(WObject::*	Method) ()

Static Public Member Functions inherited from Wt::WWebWidget
static std::string	jsStringLiteral (const std::string &v, char delimiter='\'')

Static Public Member Functions inherited from Wt::WWidget
static WString	tr (const char *key)

Static Public Attributes inherited from Wt::WInteractWidget
static const std::string	noDefault

Protected Member Functions inherited from Wt::WInteractWidget
virtual void	propagateSetEnabled (bool enabled) override

Protected Member Functions inherited from Wt::WWebWidget
virtual void	enableAjax () override

virtual WStatelessSlot *	getStateless (Method method) override

virtual void	render (WFlags< RenderFlag > flags) override

Protected Member Functions inherited from Wt::WWidget
void	setLayoutSizeAware (bool sizeAware)

virtual void	layoutSizeChanged (int width, int height)

	WWidget ()

virtual void	dropEvent (WDropEvent dropEvent)

virtual int	boxPadding (Orientation orientation) const

virtual int	boxBorder (Orientation orientation) const

void	scheduleRender (WFlags< RepaintFlag > flags=None)

Detailed Description

A simple widget to visualise a set of example source files.

Definition at line 25 of file ExampleSourceViewer.h.

Constructor & Destructor Documentation

◆ ExampleSourceViewer()

ExampleSourceViewer::ExampleSourceViewer	(	const std::string &	deployPath,
		const std::string &	examplesRoot,
		const std::string &	examplesType
	)

Constructor.

Definition at line 63 of file ExampleSourceViewer.C.

   : deployPath_(deployPath),
     examplesRoot_(examplesRoot),
     examplesType_(examplesType)
 {
   wApp->internalPathChanged().connect
     (this, &ExampleSourceViewer::handlePathChange);
  
   handlePathChange();
 }

Member Function Documentation

◆ cppTraverseDir()

void ExampleSourceViewer::cppTraverseDir	(	WStandardItem *	parent,
		const cpp17::filesystem::path &	path
	)

private

Definition at line 190 of file ExampleSourceViewer.C.

 {
   static const char *supportedFiles[] = {
     ".C", ".cpp", ".h", ".css", ".xml", ".png", ".gif", ".csv", ".ico", 0
   };
  
   auto dir = std::make_unique<FileItem>("/icons/yellow-folder-open.png",
                                                              filename(path),
                                                              "");
   FileItem *dirPtr = dir.get();
   parent->appendRow(std::move(dir));
   parent = dirPtr;
   try {
     std::set<fs::path> paths;
  
     fs::directory_iterator end_itr;
     for (fs::directory_iterator i(path); i != end_itr; ++i)
       paths.insert(*i);
  
     std::vector<std::unique_ptr<FileItem>> classes, files;
     std::vector<fs::path> dirs;
  
     while (!paths.empty()) {
       fs::path p = *paths.begin();
       paths.erase(p);
  
       // skip symbolic links and other files
       if (fs::is_symlink(p))
         continue;
  
       // skip files with an extension we do not want to handle
       if (fs::is_regular_file(p)) {
         std::string ext = p.extension().string();
         bool supported = false;
         for (const char **s = supportedFiles; *s != 0; ++s)
           if (*s == ext) {
             supported = true;
             break;
           }
  
         if (!supported)
           continue;
       }
  
       // see if we have one file of a class (.C, .h)
       fs::path companion = getCompanion(p);
       if (!companion.empty()) {
         std::set<fs::path>::iterator it_companion = paths.find(companion);
  
           if (it_companion != paths.end()) {
             std::string className = stem(p);
             escapeText(className);
             std::string label = "<i>class</i> " + className;
  
             std::unique_ptr<FileItem> classItem =
               std::make_unique<FileItem>("/icons/cppclass.png", label, std::string());
             classItem->setFlags(classItem->flags() | ItemFlag::XHTMLText);
  
             auto header
                 = std::make_unique<FileItem>("/icons/document.png", filename(p),
                                             p.string());
             auto cpp
                 = std::make_unique<FileItem>("/icons/document.png",
                                          filename(*it_companion),
                                          (*it_companion).string());
             classItem->appendRow(std::move(header));
             classItem->appendRow(std::move(cpp));
  
             classes.push_back(std::move(classItem));
             paths.erase(it_companion);
           } else {
             auto file
                 = std::make_unique<FileItem>("/icons/document.png", filename(p),
                                           p.string());
             files.push_back(std::move(file));
           }
       } else if (fs::is_directory(p)) {
         dirs.push_back(p);
       } else {
         auto file
             = std::make_unique<FileItem>("/icons/document.png", filename(p),
                                       p.string());
         files.push_back(std::move(file));
       }
     }
  
     std::sort(dirs.begin(), dirs.end(), comparePaths);
  
     for (unsigned int i = 0; i < classes.size(); i++)
       parent->appendRow(std::move(classes[i]));
  
     for (unsigned int i = 0; i < files.size(); i++)
       parent->appendRow(std::move(files[i]));
  
     for (unsigned int i = 0; i < dirs.size(); i++)
       cppTraverseDir(parent, dirs[i]);
   } catch (fs::filesystem_error& e) {
     std::cerr << e.what() << std::endl;
   }
 }

◆ handlePathChange()

void ExampleSourceViewer::handlePathChange ( )

private

Definition at line 76 of file ExampleSourceViewer.C.

 {
   WApplication *app = wApp;
  
   if (app->internalPathMatches(deployPath_)) {
     std::string example = app->internalPathNextPart(deployPath_);
  
     if (example.find("..") != std::string::npos
         || example.find('/') != std::string::npos
         || example.find('\\') != std::string::npos) {
       app->setInternalPathValid(false);
       setExample("INVALID_DIR", "INVALID");
     } else
       setExample(examplesRoot_ + example, example);
   }
 }

◆ javaTraverseDir()

void ExampleSourceViewer::javaTraverseDir	(	WStandardItem *	parent,
		const cpp17::filesystem::path &	path
	)

private

Definition at line 328 of file ExampleSourceViewer.C.

 {
   auto dir
       = std::make_unique<FileItem>("/icons/yellow-folder-open.png",
                                      filename(path),"");
   FileItem *dirPtr = dir.get();
   parent->appendRow(std::move(dir));
   parent = dirPtr;
  
   std::vector<fs::path> files, dirs;
  
   fs::directory_iterator end_itr;
   for (fs::directory_iterator i(path); i != end_itr; ++i) {
     fs::path p = *i;
     if (fs::is_directory(p)) {
       if (filename(p) == "src") {
         auto dir
             = std::make_unique<FileItem>("/icons/package-folder-open.png",
                                      filename(p), "");
         FileItem *dirPtr = dir.get();
         parent->appendRow(std::move(dir));
         javaTraversePackages(dirPtr, p, "");
       } else
         dirs.push_back(p);
     } else {
       files.push_back(p);
     }
   }
  
   std::sort(dirs.begin(), dirs.end(), comparePaths);
   std::sort(files.begin(), files.end(), comparePaths);
  
   for (auto item : dirs)
     javaTraverseDir(parent, item);
  
   for (auto item : files) {
     auto file
         = std::make_unique<FileItem>("/icons/document.png", filename(item),
                                   item.string());
     parent->appendRow(std::move(file));
   }
 }

◆ javaTraversePackages()

void ExampleSourceViewer::javaTraversePackages	(	WStandardItem *	parent,
		const cpp17::filesystem::path &	srcPath,
		const std::string	packageName
	)

private

Definition at line 292 of file ExampleSourceViewer.C.

 {
   fs::directory_iterator end_itr;
  
   FileItem *packageItem = nullptr;
   for (fs::directory_iterator i(srcPath); i != end_itr; ++i) {
     fs::path p = *i;
     if (fs::is_regular_file(p)) {
       if (!packageItem) {
         auto item = std::make_unique<FileItem>("/icons/package.png", packageName, "");
         packageItem = item.get();
         parent->appendRow(std::move(item));
       }
  
       auto file
           = std::make_unique<FileItem>("/icons/javaclass.png", filename(p),
                                     p.string());
       packageItem->appendRow(std::move(file));
     }
   }
  
   for (fs::directory_iterator i(srcPath); i != end_itr; ++i) {
     fs::path p = *i;
     if (fs::is_directory(p)) {
       std::string pn = packageName;
       if (!pn.empty())
         pn += ".";
       pn += filename(p);
  
       javaTraversePackages(parent, p, pn);
     }
   }
 }

◆ setExample()

void ExampleSourceViewer::setExample	(	const std::string &	exampleDir,
		const std::string &	example
	)

private

Definition at line 93 of file ExampleSourceViewer.C.

 {
   clear();
  
   bool exists = false;
   try {
     exists = fs::exists(exampleDir);
   } catch (std::exception&) {
   }
  
   if (!exists) {
     WApplication::instance()->setInternalPathValid(false);
     addWidget(std::make_unique<WText>("No such example: " + exampleDir));
     return;
   }
  
   model_ = std::make_shared<WStandardItemModel>(0, 1);
   if (examplesType_ == "CPP") {
     cppTraverseDir(model_->invisibleRootItem(), exampleDir);
   } else if (examplesType_ == "JAVA") {
     javaTraverseDir(model_->invisibleRootItem(), exampleDir);
   }
  
   WApplication::instance()->setTitle(tr("srcview.title." + example));
   std::unique_ptr<WText> title(std::make_unique<WText>(
                                  tr("srcview.title." + examplesType_ + "." + example)));
   title->setInternalPathEncoding(true);
  
   auto exampleView = std::make_unique<WTreeView>();
   exampleView_ = exampleView.get();
   exampleView_->setHeaderHeight(0);
   exampleView_->resize(300, WLength::Auto);
   exampleView_->setSortingEnabled(false);
   exampleView_->setModel(model_);
   exampleView_->expandToDepth(1);
   exampleView_->setSelectionMode(SelectionMode::Single);
   exampleView_->setAlternatingRowColors(false);
   exampleView_->selectionChanged().connect
     (this, &ExampleSourceViewer::showFile);
  
   auto sourceView =
         std::make_unique<SourceView>(FileItem::FileNameRole,
                                        FileItem::ContentsRole,
                                        FileItem::FilePathRole);
   sourceView_ = sourceView.get();
   sourceView_->setStyleClass("source-view");
  
   /*
    * Expand path to first file, to show something in the source viewer
    */
   WStandardItem *w = model_->item(0);
   do {
     exampleView_->setExpanded(w->index(), true);
     if (w->rowCount() > 0)
       w = w->child(0);
     else {
       exampleView_->select(w->index());
       w = 0;
     }
   } while (w);
  
   auto topLayout = std::make_unique<WVBoxLayout>();
   topLayout->addWidget(std::move(title));
  
   auto gitLayout = std::make_unique<WHBoxLayout>();
   WHBoxLayout *g = gitLayout.get();
   gitLayout->addWidget(std::move(exampleView), 0);
   gitLayout->addWidget(std::move(sourceView), 1);
   topLayout->addLayout(std::move(gitLayout), 1);
   g->setResizable(0);
  
   /*
    * FIXME, in plain HTML mode, we should set a minimum size to the source
    * view, and remove this in enableAjax() ?
    */
   // sourceView_->setHeight("100%");
  
   setLayout(std::move(topLayout));
   setStyleClass("maindiv");
 }

◆ showFile()

void ExampleSourceViewer::showFile ( )

private

Displayed the currently selected file.

Definition at line 374 of file ExampleSourceViewer.C.

                                    {
   if (exampleView_->selectedIndexes().empty())
     return;
  
   WModelIndex selected = *exampleView_->selectedIndexes().begin();
  
   // expand a folder when clicked
   if (exampleView_->model()->rowCount(selected) > 0
       && !exampleView_->isExpanded(selected))
     exampleView_->setExpanded(selected, true);
  
   // (for a file,) load data in source viewer
   sourceView_->setIndex(selected);
 }

Member Data Documentation

◆ deployPath_

std::string ExampleSourceViewer::deployPath_

private

Definition at line 38 of file ExampleSourceViewer.h.

◆ examplesRoot_

std::string ExampleSourceViewer::examplesRoot_

private

Definition at line 39 of file ExampleSourceViewer.h.

◆ examplesType_

std::string ExampleSourceViewer::examplesType_

private

Definition at line 40 of file ExampleSourceViewer.h.

◆ exampleView_

WTreeView* ExampleSourceViewer::exampleView_

private

Definition at line 35 of file ExampleSourceViewer.h.

◆ model_

std::shared_ptr<WStandardItemModel> ExampleSourceViewer::model_

private

Definition at line 42 of file ExampleSourceViewer.h.

◆ sourceView_

SourceView* ExampleSourceViewer::sourceView_

private

Definition at line 36 of file ExampleSourceViewer.h.

The documentation for this class was generated from the following files:

wt-homepage/ExampleSourceViewer.h
wt-homepage/ExampleSourceViewer.C

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExampleSourceViewer()

Member Function Documentation

◆ cppTraverseDir()

◆ handlePathChange()

◆ javaTraverseDir()

◆ javaTraversePackages()

◆ setExample()

◆ showFile()

Member Data Documentation

◆ deployPath_

◆ examplesRoot_

◆ examplesType_

◆ exampleView_

◆ model_

◆ sourceView_