cxHelpEngine.cpp

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.

Copyright (c) 2008-2014, SINTEF Department of Medical Technology
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=========================================================================*/

#include "cxHelpEngine.h"

#include <QHelpEngine>
#include "cxDataLocations.h"
#include <iostream>
#include "cxTypeConversions.h"
#include <QFileInfo>
#include <QApplication>
#include <QWidget>
#include "cxLogger.h"
#include "cxProfile.h"
#include <QDir>
#include <QTimer>

//#define DEBUG_HELP_SYSTEM // turn on to output help system focus information

namespace cx
{

HelpEngine::HelpEngine()
{
        QDir().mkpath(profile()->getPath()); // otherwise setupData() fails sometimes
        QString helpFile = profile()->getPath() + "/cx_user_doc.qhc";
        helpEngine = new QHelpEngine(helpFile, NULL);

        this->setupDataWithWarning();
        this->setupDocFile();
        this->setupDataWithWarning();

        connect(qApp, SIGNAL(focusObjectChanged(QObject*)), this, SLOT(focusObjectChanged(QObject*)));
        connect(qApp, SIGNAL(focusChanged(QWidget*, QWidget*)), this, SLOT(focusChanged(QWidget*, QWidget*)));

        QTimer::singleShot(100, this, SLOT(setInitialPage()));
}

HelpEngine::~HelpEngine()
{
        delete helpEngine;
}

void HelpEngine::setupDocFile()
{
        QString docFile = DataLocations::getDocPath()+"/cx_user_doc.qch";
        if(!QFile(docFile).exists())
                reportWarning(QString("HelpEngine: Cannot find docFile: %1").arg(docFile));
        helpEngine->unregisterDocumentation(helpEngine->namespaceName(docFile));
        if(!helpEngine->registerDocumentation(docFile))
                reportWarning(QString("HelpEngine: Documentation registration failed: %1").arg(helpEngine->error()));
}

void HelpEngine::setupDataWithWarning()
{
        bool success = helpEngine->setupData();
        // had problems here before mkdir was called on the qhc path
        if (!success)
                CX_LOG_WARNING() << QString("Help engine setup failed with error [%1]").arg(helpEngine->error());
}

void HelpEngine::setInitialPage()
{
        emit keywordActivated("user_doc_overview");
}

void HelpEngine::focusChanged(QWidget * old, QWidget * now)
{
        if (!now)
                return;
}

void HelpEngine::focusObjectChanged(QObject* newFocus)
{
        if (!newFocus)
                return;
#ifdef DEBUG_HELP_SYSTEM
        CX_LOG_CHANNEL_INFO("HELP_DB") << QString("**Focus on [%1]: %2").arg(newFocus->objectName()).arg(dynamic_cast<QWidget*>(newFocus)->windowTitle());
#endif
        QString keyword = this->findBestMatchingKeyword(newFocus);
        if (!keyword.isEmpty())
        {
#ifdef DEBUG_HELP_SYSTEM
                CX_LOG_CHANNEL_INFO("HELP_DB") << QString("    Found keyword [%1]").arg(keyword);
#endif
                emit keywordActivated(keyword);
        }
}

bool HelpEngine::isBreakChar(QChar c) const
{
        return c.isDigit() || c.isUpper();
}

bool HelpEngine::isBreakChar(QString text, int index) const
{
        if (!this->isBreakChar(text[index]))
                return false;

        bool prev = true;
        if (index>0)
                prev = this->isBreakChar(text[index-1]);

        bool next = true;
        if (index+1<text.size())
                next = this->isBreakChar(text[index+1]);

        if (!prev || !next)
                return true;

        return false;
}

QString HelpEngine::convertToKeyword(QString id) const
{
        // convert camel case strings into whitespace-separated lowercase strings:
        // MyWidget -> my widget
        // myFancy3DWidget2D -> my Fancy 3D Widget 2D -> my fancy 3d widget 2d
        // myFancyDWidget -> my Fancy D Widget -> my fancy D widget
        QString retval;
        retval.push_back(id[0]);
        for (int i=1; i<id.size(); ++i)
        {
                // break condition Q is (uppercase or digit)
                // insert whitespace before Q
                // ignore if previous was Q
                if (this->isBreakChar(id, i))
                {
                        retval.push_back("_"); // cant't get doxygenerated anchors to work properly with whitespace
                }
                retval.push_back(id[i]);
        }
        return retval.toLower();
}

QString HelpEngine::findBestMatchingKeyword(QObject* object)
{
        while (object)
        {
                QString id = this->convertToKeyword(object->objectName());
#ifdef DEBUG_HELP_SYSTEM
                CX_LOG_CHANNEL_DEBUG("HELP_DB") << QString("    examining [%1](%2)")
                                                                                   .arg(id)
                                                                                   .arg(object->metaObject()->className());
#endif
                if (id.contains("help_widget"))
                        return "";

                QMap<QString, QUrl> links = this->engine()->linksForIdentifier(id);
                if (!links.empty())
                {
                        return id;
                }

                object = object->parent();
        }
        return "";
}


}