SourceView Class Reference

View class for source code. More...

#include <SourceView.h>

Inheritance diagram for SourceView:

Public Member Functions
	SourceView (ItemDataRole fileNameRole, ItemDataRole contentRole, ItemDataRole filePathRole)
	Constructor.
virtual	~SourceView ()
	Destructor.
bool	setIndex (const WModelIndex &index)
	Sets the model index.
virtual std::unique_ptr< WWidget >	renderView ()
	Returns the widget that renders the view.
Public Member Functions inherited from Wt::WViewWidget
	WViewWidget ()
void	update ()
virtual void	load () override
virtual void	render (WFlags< RenderFlag > flags) override
virtual void	refresh () 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	isEnabled () const override
virtual void	setPopup (bool popup) 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	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
virtual std::unique_ptr< WWidget >	removeWidget (WWidget *widget)
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
virtual void	scheduleThemeStyleApply (std::shared_ptr< Wt::WTheme > theme, WWidget *child, int role)
virtual void	applyThemeStyles ()
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
std::string	imageExtension (const std::string &fileName)

Private Attributes
WModelIndex	index_
	The index that is currently displayed.
Wt::ItemDataRole	fileNameRole_
	The role that is currently displayed.
Wt::ItemDataRole	contentRole_
Wt::ItemDataRole	filePathRole_
std::shared_ptr< WMemoryResource >	imageResource_

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)
Protected Member Functions inherited from Wt::WWebWidget
virtual void	propagateSetEnabled (bool enabled) override
virtual void	enableAjax () override
virtual WStatelessSlot *	getStateless (Method method) 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

View class for source code.

A view class is used so that no server-side memory is used while displaying a potentially large file.

Definition at line 28 of file SourceView.h.

Constructor & Destructor Documentation

SourceView()

SourceView::SourceView	(	ItemDataRole	fileNameRole,
		ItemDataRole	contentRole,
		ItemDataRole	filePathRole
	)

Constructor.

The fileNameRole will be used to retrieve data from a file to be displayed. If no data is set for this role, then contentRole should hold the data as a string.

Definition at line 20 of file SourceView.C.

    : fileNameRole_(fileNameRole),
      contentRole_(contentRole),
      filePathRole_(filePathRole),
      imageResource_(0)
{}

~SourceView()

SourceView::~SourceView ( )

virtual

Destructor.

Definition at line 29 of file SourceView.C.

{ }

Member Function Documentation

imageExtension()

std::string SourceView::imageExtension ( const std::string &  fileName )

private

Definition at line 203 of file SourceView.C.

{
  static const char *imageExtensions[] = {
    ".png", ".gif", ".jpg", "jpeg", ".ico", 0
  };
 
  fs::path p(fileName);
  std::string extension = p.extension().string();
 
  for (const char **s = imageExtensions; *s != 0; ++s)
    if (*s == extension)
      return extension.substr(1);
 
  return std::string();
}

renderView()

std::unique_ptr< WWidget > SourceView::renderView ( )

virtual

Returns the widget that renders the view.

Returns he view contents: renders the file to a WText widget. WViewWidget deletes this widget after every rendering step.

Implements Wt::WViewWidget.

Definition at line 97 of file SourceView.C.

{
  if (!index_.isValid()) {
    // no content
    auto result = std::make_unique<WText>();
    result->setInline(false);
    return result;
  }
 
  /*
   * read the contents, from string or file name
   */
  cpp17::any contentsData = index_.data(contentRole_);
  std::string content;
  if (cpp17::any_has_value(contentsData))
   content = asString(contentsData).toUTF8();
  cpp17::any fileNameData = index_.data(fileNameRole_);
  std::string fileName =
    asString(fileNameData).toUTF8();
  cpp17::any filePathData = index_.data(filePathRole_);
  std::string filePath;
  if (cpp17::any_has_value(filePathData))
    filePath = asString(filePathData).toUTF8();
 
  /*
   * determine source language, for source highlight
   */
  std::string lang = getLanguageFromFileExtension(fileName);
  if (content != "" && content.substr(0, 100).find("-*- C++ -*-")
      != std::string::npos)
    lang = "cpp";
 
  std::string outputFileName;
 
  if (lang != "") {
    std::string inputFileName;
 
    if (cpp17::any_has_value(filePathData))
      inputFileName = filePath;
    else {
      inputFileName = tempFileName();
      std::ofstream out(inputFileName.c_str(),
                        std::ios::out | std::ios::binary);
      out.write(content.c_str(), (std::streamsize)content.length());
      out.close();
    }
 
    outputFileName = tempFileName();
 
    std::string sourceHighlightCommand = "source-highlight ";
    sourceHighlightCommand += "--src-lang=" + lang + " ";
    sourceHighlightCommand += "--out-format=xhtml ";
    sourceHighlightCommand += "--input=" + inputFileName + " ";
    sourceHighlightCommand += "--output=" + outputFileName + " ";
 
    std::cerr << sourceHighlightCommand << std::endl;
    bool sourceHighlightOk = system(sourceHighlightCommand.c_str()) == 0;
 
    if (sourceHighlightOk)
      content = readFileToString(outputFileName);
    else {
      content = readFileToString(inputFileName);
      lang = "";
    }
    unlink(outputFileName.c_str());
 
    if (!cpp17::any_has_value(filePathData))
      unlink(inputFileName.c_str());
  }
 
  if (content == "")
    // do not load binary files, we would need to perform proper UTF-8
    // transcoding to display them
    if (!boost::iends_with(fileName, ".jar")
        && !boost::iends_with(fileName, ".war")
        && !boost::iends_with(fileName, ".class"))
      content = readFileToString(fileName);
 
  std::unique_ptr<WWidget> result;
 
  if (!imageExtension(fileName).empty()) {
    std::unique_ptr<WImage> image(std::make_unique<WImage>());
    imageResource_ = std::make_shared<WMemoryResource>();
    imageResource_->setMimeType("mime/" + imageExtension(fileName));
    imageResource_->setData((const unsigned char*)content.data(),
                            (int)content.length());
    image->setImageLink(WLink(imageResource_));
    result = std::move(image);
  } else if (lang != "") {
    auto text = std::make_unique<WText>();
    text->setTextFormat(TextFormat::UnsafeXHTML);
    text->setText(content);
    result = std::move(text);
  } else {
    auto text = std::make_unique<WText>();
    text->setTextFormat(TextFormat::Plain);
    text->setText(content);
    result = std::move(text);
  }
 
  result->setInline(false);
  WApplication::instance()
    ->doJavaScript(result->jsRef() + ".parentNode.scrollTop = 0;");
  return result;
}

setIndex()

bool SourceView::setIndex

(

const WModelIndex &

index

)

Sets the model index.

Returns true whether the view will be rerendered. The view will only be rerendered if the index contains new data.

Definition at line 32 of file SourceView.C.

{
  if (index != index_ && index.isValid()) {
    std::string fp = !cpp17::any_has_value(index.data(filePathRole_)) ? std::string()
      : asString(index.data(filePathRole_)).toUTF8();
 
    if (cpp17::any_has_value(index.data(contentRole_))
        || (!fp.empty() && !fs::is_directory(fp))) {
      index_ = index;
      update();
 
      return true;
    }
  }
 
  return false;
}

Member Data Documentation

contentRole_

Wt::ItemDataRole SourceView::contentRole_

private

Definition at line 65 of file SourceView.h.

fileNameRole_

Wt::ItemDataRole SourceView::fileNameRole_

private

The role that is currently displayed.

Definition at line 64 of file SourceView.h.

filePathRole_

Wt::ItemDataRole SourceView::filePathRole_

private

Definition at line 66 of file SourceView.h.

imageResource_

std::shared_ptr<WMemoryResource> SourceView::imageResource_

private

Definition at line 68 of file SourceView.h.

index_

WModelIndex SourceView::index_

private

The index that is currently displayed.

Definition at line 61 of file SourceView.h.

---

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

• wt-homepage/SourceView.h
• wt-homepage/SourceView.C