Prechádzanie podstromu pomocou QAbstractProxyModel

8.7.2012 19:40 | Přečteno: 617× | Programovanie | poslední úprava: 8.7.2012 19:39

Posledné dva dni som sa pustil trochu do nápravy starých hriechov. Konkrétne som začal refaktorovať jednu triedu s takto krásnymi komentármi:

// Túto triedu nedá dokopy nikto!
/// @todo Otestujte niekto prosím túto funkciu, ja sa jej bojím.

No nie je to neodolateľné?

Na začiatok pár slov o tom, čo sa pomocou QAbstractProxyModel-u pokúšam dosiahnuť.

Kedysi dávno (pár mesiacov pred vydaním Qt 4.7) som začal pracovať na jednom projekte, ktorý ma užívateľské rozhranie v QML. Aplikácia vie zobrazovať skladby zoradené podľa rôznych kritérií do kategórií napr. album -> skladba, autor -> skladba …

Informácie o skladbách a ich zaradení sú získavané štandardne cez QAbstractItemModel. Zobrazovanie je riešené v užívateľskom rozhraní pomocou QML (dva samostatné ListView) a v administrátorskom rozhraní pomocou QTreeView.

Prvok ListView je schopný zobrazovať len jednoúrovňové zoznamy, nie stromové, ako je to v tomto prípade. Preto bolo potrebné vymyslieť riešenie, ako takéto dáta zobrazovať v užívateľskom rozhraní cez QML.

Riešenie pomocou QAbstractProxyModel

Proxy modely slúžia na operácie ako filtrovanie, alebo transformácia položiek. V mojom prípade som chcel vytvoriť proxy model, ktorý sprístupni len časť modelu určenú koreňovým indexom. Rozhranie TreeBrowserProxyModel má preto navyše len metódu setRootIndex.

Najväčší problém, s ktorým som pri implementácii modelu bojoval (a nebol som sám) je premapovanie indexov. Všetky riešenia, ktoré som doteraz videl si vytvárali vlastnú kópiu štruktúry pôvodného modelu, čo zahodí väčšinu výhod modelov v Qt (rýchlosť, množstvo potrebnej pamäte, …).

Okrem počiatočnej kópie štruktúry sa musí štruktúra udržiavať synchronizovaná s pôvodným modelom. To znamená, že sa musia sledovať nasledujúce signály:

dataChanged(QModelIndex, QModelIndex);
headerDataChanged(Qt::Orientation, int, int);
rowsAboutToBeInserted(QModelIndex, int, int);
rowsInserted(QModelIndex, int, int);
columnsAboutToBeInserted(QModelIndex, int, int);
columnsInserted(QModelIndex, int, int);
rowsAboutToBeRemoved(QModelIndex, int, int);
rowsRemoved(QModelIndex, int, int);
columnsAboutToBeRemoved(QModelIndex, int, int);
columnsRemoved(QModelIndex, int, int);
layoutAboutToBeChanged();
layoutChanged();
modelAboutToBeReset();
modelReset();

Dávnejšie som videl na internete niekoľko implementácií takéhoto proxy modelu. Všetky mali veľkosť približne 1000 riadkov a hrôzostrašný kód. Rovnako vyzerala aj moja implementácia (neprechádzala síce unit testmi, ale aspoň na väčšinu prípadov fungovala).

Malý hack, veľké zjednodušenie kódu

Pri refaktorovaní kódu som dostal perfektný nápad - namiesto zložitého mapovania indexov použiť pôvodné dáta indexov zo zdrojového modelu.

QModelIndex TreeBrowserProxyModel::mapFromSource(const QModelIndex &sourceIndex) const
{
	return createIndex(sourceIndex.row(), sourceIndex.column(), sourceIndex.internalPointer());
}

QModelIndex TreeBrowserProxyModel::mapToSource(const QModelIndex &proxyIndex) const
{
	return sourceModel()->createIndex(proxyIndex.row(), proxyIndex.column(), proxyIndex.internalPointer());
}

Nad týmto riešením som rozmýšľal už pri pôvodnej implementácii, ale vtedy som si nespomenul na žiaden spôsob ako prekonať obmedzenie prístupu k protected metóde createIndex.

Aby som mohol volať metódu createIndex som si vytvoril triedu deklarujúcu TreeBrowserProxyModel ako friend.

class TreeBrowsableModel: public QAbstractItemModel
{
Q_OBJECT
friend class TreeBrowserProxyModel;
};

Následne stačí v metóde mapToSource pretypovať QAbstractItemModel na TreeBrowsableModel:

reinterpret_cast<TreeBrowsableModel>(sourceModel())->createIndex(proxyIndex.row(), proxyIndex.column(), proxyIndex.internalPointer());

Moje riešenie si síce porušuje zapuzdrenie, ale pri danej úspore kódu a jednoduchosti ho považujem za dobrý kompromis.

       

Obrázky

Komentáře

[Bedňa]

Zapúzdrenie vždy predĺži kód, však to je pointa Niekedy (vždy) to vedie k veľa kódu naviac, preto niektorí ľudia tvrdia že C++ je zbytočné keď tu máme C a na zložitejšie veci lepšie jazyky

[mirec]

Čiste teoreticky by zapúzdrenie nemalo robiť žiaden rozdiel v dĺžke kódu. Jeho účel je zabalenie funkcionality do rozhraní. No a inak v C síce nič ako private nie je, ale rozdelenie na privátne a verejné hlavičkové súbory sa používa bežne ;)

[Bedňa]

Prakticky je to tak zoberieš si premennú použiješ ju a nemusíš písať metódu, to vždy ušetrí kód, otázka je ako to zostane s čitateľnosťou kódu.

[mirec]

Väčšinou nie sú prístupové metódy len o nastavení / vrátení niečoho, ale aj o kontrole. Ak ide len o nastavenie a vrátenie nie je problém to v lepšom editore / IDE poriešiť pomocou snippetu. Ja osobne používam vim + ultisnips.

[Josef Kufner]

A pomůže takový snippet i při čtení?

[mirec]

Příloha:

• gettersetter.png (4760 bytů)

To nie, ale zobrazenie záleží od editoru. Prikladám screenshot.

[:::]

// Túto triedu nedá dokopy nikto!
/// @todo Otestujte niekto prosím túto funkciu, ja sa jej bojím.

to me pripomelo...

[mirec]

Takto to momentálne funguje u nás v práci ;) Inak tento projekt som písal z 95% sám, momentálne vyvíjam len ja sám a vlastne celý tím okrem hardvéristov som zase len ja sám ;) Mám taký pocit, že si pomaly začnem sám písať rozhorčené maily nech ma má kto zdrbať ;)