/*
* Copyright 2012 Canonical Ltd.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see .
*
* Authors:
* Renato Araujo Oliveira Filho
*/
extern "C" {
#include
}
#include "qmenumodel.h"
#include "converter.h"
#include
class CacheData
{
public:
CacheData(QMenuModel *link, int pos)
: link(link),
pos(pos)
{
}
~CacheData()
{
delete link;
}
QMenuModel *link;
int pos;
};
/*!
\qmltype QMenuModel
\brief The QMenuModel class implements the base list model for menus
\b {This component is under heavy development.}
This is a abstracted class used by \l QDBusMenuModel.
*/
/*! \internal */
QMenuModel::QMenuModel(GMenuModel *other, QObject *parent)
: QAbstractListModel(parent),
m_menuModel(0),
m_signalChangedId(0)
{
setMenuModel(other);
connect(this, SIGNAL(rowsInserted(const QModelIndex &, int, int)), SIGNAL(countChanged()));
connect(this, SIGNAL(rowsRemoved(const QModelIndex &, int, int)), SIGNAL(countChanged()));
connect(this, SIGNAL(modelReset()), SIGNAL(countChanged()));
}
/*! \internal */
QMenuModel::~QMenuModel()
{
clearModel();
}
/*!
\qmlmethod QDBusMenuModel::get(int)
Returns the item at index in the model. This allows the item data to be accessed from JavaScript:
\b Note: methods should only be called after the Component has completed.
*/
QVariantMap QMenuModel::get(int row) const
{
QVariantMap result;
QModelIndex index = this->index(row);
if (index.isValid()) {
QMap data = itemData(index);
const QHash roleNames = this->roleNames();
Q_FOREACH(int i, roleNames.keys()) {
result.insert(roleNames[i], data[i]);
}
}
return result;
}
/*!
\qmlmethod QDBusMenuModel::count()
The number of data entries in the model.
\b Note: methods should only be called after the Component has completed.
*/
int QMenuModel::count() const
{
return rowCount();
}
/*! \internal */
void QMenuModel::setMenuModel(GMenuModel *other)
{
if (m_menuModel == other) {
return;
}
beginResetModel();
clearModel();
m_menuModel = other;
if (m_menuModel) {
g_object_ref(m_menuModel);
// this will trigger the menu load
(void) g_menu_model_get_n_items(m_menuModel);
m_signalChangedId = g_signal_connect(m_menuModel,
"items-changed",
G_CALLBACK(QMenuModel::onItemsChanged),
this);
}
endResetModel();
}
/*! \internal */
GMenuModel *QMenuModel::menuModel() const
{
return m_menuModel;
}
/*! \internal */
void QMenuModel::clearModel()
{
if (m_menuModel) {
g_signal_handler_disconnect(m_menuModel, m_signalChangedId);
m_signalChangedId = 0;
g_object_unref(m_menuModel);
m_menuModel = NULL;
}
Q_FOREACH(CacheData *data, m_cache) {
delete data;
}
m_cache.clear();
}
/*! \internal */
QHash QMenuModel::roleNames() const
{
static QHash roles;
if (roles.isEmpty()) {
roles[Action] = "action";
roles[Label] = "label";
roles[LinkSection] = "linkSection";
roles[LinkSubMenu] = "linkSubMenu";
roles[Extra] = "extra";
}
return roles;
}
/*! \internal */
QVariant QMenuModel::data(const QModelIndex &index, int role) const
{
QVariant attribute;
int rowCountValue = rowCount();
if ((rowCountValue > 0) && (index.row() >= 0) && (index.row() < rowCountValue)) {
if (m_menuModel) {
switch (role) {
case Action:
attribute = getStringAttribute(index, G_MENU_ATTRIBUTE_ACTION);
break;
case Label:
attribute = getStringAttribute(index, G_MENU_ATTRIBUTE_LABEL);
break;
case LinkSection:
attribute = getLink(index, G_MENU_LINK_SECTION);
break;
case LinkSubMenu:
attribute = getLink(index, G_MENU_LINK_SUBMENU);
break;
case Extra:
attribute = getExtraProperties(index);
break;
default:
break;
}
}
}
return attribute;
}
/*! \internal */
QModelIndex QMenuModel::parent(const QModelIndex &index) const
{
return QModelIndex();
}
/*! \internal */
int QMenuModel::rowCount(const QModelIndex &) const
{
if (m_menuModel) {
return g_menu_model_get_n_items(m_menuModel);
}
return 0;
}
/*! \internal */
QVariant QMenuModel::getStringAttribute(const QModelIndex &index,
const QString &attribute) const
{
QVariant result;
gchar* value = NULL;
g_menu_model_get_item_attribute(m_menuModel,
index.row(),
attribute.toUtf8().data(),
"s", &value);
if (value) {
result = QVariant(QString::fromUtf8(value));
g_free(value);
}
return result;
}
/*! \internal */
QVariant QMenuModel::getLink(const QModelIndex &index,
const QString &linkName) const
{
GMenuModel *link;
link = g_menu_model_get_item_link(m_menuModel,
index.row(),
linkName.toUtf8().data());
if (link) {
QMenuModel *result = 0;
Q_FOREACH(CacheData *cache, m_cache) {
if ((cache->link->menuModel() == link) &&
(cache->pos == index.row())) {
result = cache->link;
break;
}
}
if (result == 0) {
QMenuModel *self = const_cast(this);
result = new QMenuModel(link, self);
self->m_cache << new CacheData(result, index.row());
}
g_object_unref(link);
return QVariant::fromValue(result);
}
return QVariant();
}
/*! \internal */
QString QMenuModel::parseExtraPropertyName(const QString &name) const
{
QString newName(name);
if (name.startsWith("x-")) {
newName = name.mid(2);
}
return newName.replace("-", "_");
}
/*! \internal */
QVariant QMenuModel::getExtraProperties(const QModelIndex &index) const
{
GMenuAttributeIter *iter = g_menu_model_iterate_item_attributes(m_menuModel, index.row());
if (iter == NULL) {
return QVariant();
}
QVariantMap extra;
const gchar *attrName = NULL;
GVariant *value = NULL;
while (g_menu_attribute_iter_get_next (iter, &attrName, &value)) {
if (strncmp("x-", attrName, 2) == 0) {
extra.insert(parseExtraPropertyName(attrName),
Converter::toQVariant(value));
}
}
return extra;
}
/*! \internal */
QList QMenuModel::cache() const
{
return m_cache;
}
/*! \internal */
void QMenuModel::onItemsChanged(GMenuModel *model,
gint position,
gint removed,
gint added,
gpointer data)
{
QMenuModel *self = reinterpret_cast(data);
if (removed > 0) {
self->beginRemoveRows(QModelIndex(), position, position + removed - 1);
for(int i=position, iMax=position+removed; i < iMax; i++) {
QList lst = self->m_cache;
Q_FOREACH(CacheData* data, lst) {
if (data->pos == position) {
self->m_cache.removeOne(data);
delete data;
} else if (data->pos >= position) {
data->pos -= removed;
}
}
}
self->endRemoveRows();
}
if (added > 0) {
self->beginInsertRows(QModelIndex(), position, position + added - 1);
for(int i=position, iMax=position+added; i < iMax; i++) {
Q_FOREACH(CacheData* data, self->m_cache) {
if (data->pos >= position) {
data->pos += added;
}
}
}
self->endInsertRows();
}
}