# Panoramica dell'architettura KDE

## Struttura della libreria

### Librerie per nome

kdecore

- La libreria kdecore è il framework di base per tutti i programmi basati su KDE. Fornisce l'accesso alla configurazione del sistema, alla gestione della linea di comando, al caricamento e alla manipolazione delle icone, ad alcuni tipi speciali di comunicazione interprocesso, alla gestione dei file e ad altre svariate utility.

kdeui

- La libreria `kdeui` contiene molti widget e finestre di dialogo che non sono presenti nella libreria Qt o che questa fornisce in una versione meno completa. Sono inclusi anche molti widget derivati da quelli presenti in Qt che si integrano meglio nel desktop KDE adattandosi alle preferenze dell'utente.

kio

- La libreria `kio` contiene funzioni per l'input/output asincrono trasparente alla rete e l'accesso alla gestione dei tipi MIME. Essa fornisce anche la finestra di dialogo KDE per i file e le sue classi di aiuto.

kjs

- La libreria `kjs` fornisce un'implementazione di JavaScript.

khtml

- La libreria `khtml` contiene il componente KHTML, un widget per navigare nelle pagine HTML, un parser per il modello DOM, le relative API e le interfacce per Java e JavaScript.

### Gruppi di classi

Struttura principale dell'applicazione - classi necessarie a quasi tutte le applicazioni.

- ### KApplication

  Inizializza e controlla un'applicazione KDE

- ### KUniqueApplication

  Assicura che solo un'istanza di un'applicazione possa essere eseguita contemporaneamente.

- ### KAboutData

  Contiene i dati per la finestra delle informazioni.

- ### KCmdLineArgs

  Elabora gli argomenti a linea di comando.

Impostazioni di configurazione - accede al database gerarchico della configurazione di KDE, alle impostazioni globali e alle risorse dell'applicazione.

- ### KConfig

  Fornisce accesso al database di configurazione di KDE.

- ### KSimpleConfig

  Accede ai semplici file di configurazione non gerarchici.

- ### KDesktopFile

  Accede ai file `.desktop`

- ### KGlobalSettings

  È un comodo accesso alle impostazioni non specifiche dell'applicazione.

Gestione dei file e degli URL - decodifica di URL, file temporanei ecc.

- ### KURL

  Rappresenta e interpreta degli URL.

- ### KTempFile

  Crea file univoci per i dati temporanei.

- ### KSaveFile

  Permette di salvare i file atomicamente.

Comunicazione interprocesso - classi di aiuto per DCOP e chiamate ai sottoprocessi.

- ### KProcess

  Chiama e controlla i processi figlio.

- ### KShellProcess

  Chiama i processi figli attraverso una shell.

- ### PtyProcess

  Comunicazione con un processo figlio attraverso uno pseudo terminale.

- ### KIPC

  Semplice meccanismo di comunicazione IPC che usa i ClientMessages di X11.

- ### DCOPClient

  Trasmissione dei messaggi DCOP.

- ### KDCOPPropertyProxy

  Una classe proxy che pubblica le proprietà Qt attraverso DCOP.

- ### KDCOPActionProxy

  Una classe proxy che pubblica un'interfaccia DCOP per le azioni.

Classi di utilità - gestione della memoria, espressioni regolari, manipolazione di stringhe e numeri casuali.

- ### KRegExp

  Verifica le espressioni regolari POSIX.

- ### KStringHandler

  Un'interfaccia stravagante per la manipolazione di stringhe.

- ### KZoneAllocator

  Efficiente allocatore di memoria per grandi insiemi di piccoli oggetti.

- ### KRandomSequence

  Generatore di numeri pseudo casuali.

Tasti speciali - classi che aiutano a stabilire scorciatoie da tastiera coerenti per tutto il desktop.

- ### KAccel

  Collezione di scorciatoie da tastiera.

- ### KStdAccel

  Facile accesso alle comuni scorciatoie da tastiera.

- ###

  Collezione di scorciatoie da tastiera di sistema.

Elaborazione di immagini - manipolazione e caricamento di icone.

- ### KIconLoader

  Carica le icone in modo conforme con il tema.

- ### KIconTheme

  Classe di aiuto per KIconLoader.

- ### KPixmap

  Una classe pixmap con estese funzioni di retinatura.

- ### KPixmapEffect

  Effetti pixmap come gradienti e pattern.

- ### KPixmapIO

  Conversione veloce da `QImage` a `QPixmap`.

Drag and Drop - oggetti trascinabili per i colori e gli URL.

- ### KURLDrag

  Un oggetto trascinabile per gli URL.

- ### KColorDrag

  Un oggetto trascinabile per i colori.

- ### KMultipleDrag

  Permette di costruire oggetti trascinabili partendo da altri oggetti.

Completamento automatico

- ### KCompletion

  Completamento automatico generico per le stringhe.

- ### KURLCompletion

  Completamento automatico degli URL.

- ### KShellCompletion

  Completamento automatico di eseguibili.

Widget - classi widget per list view, righelli, selezione dei colori, ecc.

- ### KListView

  Una variante di `QListView` che segue le impostazioni di sistema di KDE.

- ### KListBox

  Una variante di `QListBox` che segue le impostazioni di sistema di KDE.

- ### KIconView

  Una variante di `QIconView` che segue le impostazioni di sistema di KDE.

- ### KLineEdit

  Una variante di `QLineEdit` con il supporto per il completamento del testo.

- ### KComboBox

  Una variante di `QComboBox` con supporto per il completamento del testo.

- ### KFontCombo

  Una casella per la selezione dei font.

- ### KColorCombo

  Una casella per la selezione dei colori.

- ### KColorButton

  Un pulsante per selezionare i colori.

- ### KURLCombo

  Una casella per selezionare nomi di file e URL.

- ### KURLRequester

  Una casella di testo per selezionare nomi di file e URL.

- ### KRuler

  Un widget righello.

- ### KAnimWidget

  animazioni.

- ### KNumInput

  Un widget per inserire numeri.

- ### KPasswordEdit

  Un widget per inserire password.

Finestre di dialogo - finestre complete di tutte le funzioni per selezionare file, colori e font.

- ### KFileDialog

  Una finestra di dialogo per selezionare i file.

- ### KColorDialog

  Una finestra di dialogo per selezionare i colori.

- ### KFontDialog

  Una finestra di dialogo per selezionare i font.

- ### KIconDialog

  Una finestra di dialogo per selezionare le icone.

- ### KKeyDialog

  Una finestra di dialogo per modificare le scorciatoie da tastiera.

- ### KEditToolBar

  Una finestra di dialogo per modificare le barre degli strumenti.

- ### KTipDialog

  Una finestra di dialogo che visualizza i suggerimenti del giorno.

- ### KAboutDialog

  Una finestra di dialogo che visualizza le informazioni.

- ### KLineEditDlg

  Una semplice finestra di dialogo per inserire testo.

- ### KURLRequesterDlg

  Una semplice finestra di dialogo per inserire URL.

- ### KMessageBox

  Una finestra di dialogo per segnalare errori ed avvertimenti.

- ### KPasswordDialog

  Una finestra di dialogo per inserire password.

Azioni e interfacce grafiche XML.

- ### KAction

  Astrazione per un'azione che può essere collegata alle barre dei menu e alle barre degli strumenti.

- ### KActionCollection

  Un insieme di azioni.

- ### KXMLGUIClient

  Una porzione di GUI composta da una collezione di azioni e da un albero DOM che rappresenta le loro posizioni nell'interfaccia grafica.

- ### KPartManager

  Gestisce l'attivazione dei client XMLGUI.

Plugin e componenti

- ### KLibrary

  Rappresenta una libreria dinamica.

- ### KLibLoader

  Caricamento di librerie condivise.

- ### KLibFactory

  Costruttore di oggetti nei plugin.

- ### KServiceType

  Rappresenta un tipo di servizio.

- ### KService

  Rappresenta un servizio.

- ### KMimeType

  Rappresenta un tipo MIME.

- ### KServiceTypeProfile

  Preferenze dell'utente per la mappatura dei tipi MIME.

- ### KTrader

  Richiesta di servizi.

## Grafica

### Grafica a basso livello con QPainter

#### Visualizzazione con QPainter

Il modello a basso livello di Qt per le immagini è basato sulle funzioni fornite da X11 e da altri sistemi grafici per i quali esiste il port di Qt. Tuttavia esso estende queste funzioni implementando funzionalità aggiuntive come le trasformazioni geometriche arbitrarie del testo e delle pixmap.

La classe grafica principale per il disegno 2D è QPainter. Essa può disegnare su un QPaintDevice. Sono stati implementati tre tipi di QPaintDevice: il primo è QWidget che rappresenta un widget sullo schermo. Il secondo è QPrinter che rappresenta una stampante e produce un output PostScript. Il terzo è la classe QPicture che registra i comandi di disegno e può salvarli sul disco per poterli riprodurre in seguito. Un possibile formato di memorizzazione per questi comandi di disegno è lo standard SVG del W3C.

In questo modo è possibile stampare riutilizzando il codice di disegno usato per visualizzare un widget. Naturalmente il codice viene usato in un contesto leggermente diverso: il disegno di un widget viene fatto quasi esclusivamente nel metodo paintEvent() di una classe widget.

    void FooWidget::paintEvent()
    {
        QPainter p(this);
        // Impostazione del QPainter
        // Uso del QPainter
    }

Quando si disegna su una stampante, ci si deve assicurare di usare QPrinter::newPage() per terminare una pagina e iniziarne una nuova - questo non è normalmente rilevante nel disegno di widget. Inoltre, quando si stampa, si potrebbe voler usare le metriche dei dispositivi per calcolare le coordinate.

#### Trasformazioni

Normalmente QPainter disegnerà nel sistema naturale di coordinate del dispositivo usato. Questo significa che se si disegna una linea lungo l'asse orizzontale lunga 10 unità, verrà visualizzata come una linea orizzontale sullo schermo con una lunghezza di 10 pixel. Comunque, QPainter può applicare delle trasformazioni geometriche prima di disegnare effettivamente forme e curve. Una trasformazione geometrica mappa linearmente le coordinate x e y in x' e y' in base alla matrice seguente

In questa equazione la matrice 3x3 può essere impostata con QPainter::setWorldMatrix() ed è del tipo QWMatrix. Normalmente è la matrice identità, cioè m11 e m22 valgono uno e gli altri parametri zero. Ci sono tre differenti gruppi fondamentali di trasformazioni:

- #### Traslazioni

  Queste muovono tutti i punti di un oggetto di una quantità fissa in qualche direzione. Una matrice di traslazione può essere ottenuta chiamando il metodo m.translate(dx, dy) di QWMatrix. Questo corrisponde alla matrice

- #### Scalature

  Queste allungano o riducono le coordinate di un oggetto, rendendolo più grande o più piccolo senza distorcerlo. Una trasformazione di scala può essere applicata a una QWMatrix chiamando il metodo m.scale(sx, sy). Questo corrisponde alla matrice

  Impostando uno dei parametri con un valore negativo si ottiene la riflessione del sistema di coordinate.

- #### Deformazioni

  Una distorsione del sistema di coordinate che utilizza due parametri. Questa trasformazione può essere applicata chiamando m.shear(sh, sv), e corrisponde alla matrice

- #### Rotazione

  Questa trasformazione ruota un oggetto. Una rotazione può essere applicata chiamando il metodo m.rotate(alpha). Notare che l'angolo deve essere in gradi, non in angoli matematici! La matrice corrispondente è

  Notare che una rotazione è equivalente alla combinazione di una scalatura e di una deformazione.

Ecco alcune immagini che mostrano gli effetti delle trasformazioni elementari sulla nostra mascotte.

a) Normale | b) Ruotata di 30 gradi | c) deformata di 0.4 | d) Riflessa

Le trasformazioni possono essere combinate moltiplicando le matrici elementari. Notare che le operazioni sulle matrici generalmente non sono commutative e quindi l'effetto combinato di una loro concatenazione dipende dall'ordine con cui sono state moltiplicate le matrici.

#### Impostare gli attributi di disegno

Si può modificare la visualizzazione di linee, curve e sagome di poligoni impostando una penna speciale con QPainter::setPen(). L'argomento di questa funzione è un oggetto QPen, che memorizza le proprietà di stile, colore, stile unione e stile di pennino.

Lo stile della penna è membro dell'enumerazione Qt::PenStyle e può avere uno dei seguenti valori:

Lo stile unione è membro dell'enumerazione Qt::PenJoinStyle. Specifica come deve essere disegnata la giunzione tra le linee che sono unite le une alle altre. Può avere uno dei seguenti valori:

a) MiterJoin | c) BevelJoin | b) RoundJoin

Lo stile del pennino è un membro dell'enumerazione Qt::PenCapStyle e specifica come devono essere disegnati i punti terminali di una linea. Può avere uno dei valori della seguente tabella:

a) FlatCap | b) SquareCap | c) RoundCap

#### Impostare gli attributi di riempimento

Lo stile di riempimento di poligoni, cerchi o rettangoli può essere modificato impostando un pennello speciale con QPainter::setBrush(). Questa funzione riceve come argomento un oggetto QBrush. I pennelli possono essere costruiti in quattro modi differenti:

- QBrush::QBrush() - Crea un pennello che non riempie le aree.

- QBrush::QBrush(BrushStyle) - Crea un pennello nero con uno dei motivi predefiniti mostrati sotto.

- QBrush::QBrush(const QColor &, BrushStyle) - Crea un pennello colorato con uno dei motivi di default mostrati sotto.

- QBrush::QBrush(const QColor &, const QPixmap) - Crea un pennello colorato con un motivo personalizzato fornito come secondo parametro.

Uno stile predefinito del pennello è un valore dell'enumerazione Qt::BrushStyle. Ecco un'immagine di tutti i motivi predefiniti:

Un ulteriore modo per personalizzare il comportamento del pennello consiste nell'usare la funzione QPainter::setBrushOrigin().

#### Colore

I colori vengono usati quando si disegnano curve e quando si riempiono forme. In Qt i colori sono rappresentati dalla classe QColor. Qt non supporta funzioni grafiche avanzate come i profili di colore ICC e la correzione del colore. I colori sono normalmente costruiti specificando i componenti rosso, verde e blu, come il modello RGB usato per i pixel di un monitor.

È possibile anche usare la tonalità, la saturazione e la luminosità. Questa rappresentazione HSV è quella usata nella finestra di dialogo Gtk per il colore, per es. in GIMP. Qui, la tonalità corrisponde ad un angolo sulla ruota del colore, mentre la saturazione corrisponde alla distanza dal centro del cerchio. La luminosità può essere scelta su un'indicatore separato.

#### Altre impostazioni

Normalmente, quando si dipinge su un dispositivo, i pixel disegnati sostituiscono quelli che erano presenti in precedenza. Questo significa che se si dipinge una certa regione con il colore rosso e successivamente la si dipinge con il colore blu sarà visibile solo quest'ultimo. Il sistema grafico di Qt non supporta direttamente la trasparenza, cioè la mescolanza del colore di primo piano con quello dello sfondo; questa si può ottenere facilmente usando gli operatori booleani. Il metodo QPainter::setRasterOp() imposta l'operatore usato, che è un valore dell'enumerazione RasterOp.

Il valore predefinito è CopyROP, che ignora lo sfondo mentre una scelta molto frequente è XorROP. Se si dipinge una linea nera con questo operatore su un'immagine colorata, l'area coperta verrà invertita. Questo effetto, utilizzato nei programmi di grafica per creare i bordi delle selezioni, è noto come col nome di "formiche che marciano".

#### Disegnare grafica elementare

Di seguito si elencheranno gli elementi grafici principali supportati da QPainter. Molti di essi possiedono versioni sovraccaricate che ricevono un diverso numero di parametri. Per esempio, i metodi che si occupano dei rettangoli ricevono come argomento un oggetto QRect oppure un insieme di quattro interi.

- Disegnare un singolo punto - drawPoint().

- Disegnare linee - drawLine(), drawLineSegments() e drawPolyLine().

- Disegnare e riempire rettangoli - drawRect(), drawRoundRect(), fillRect() e eraseRect().

- Disegnare e riempire cerchi, ellissi e parti di essi - drawEllipse(), drawArc(), drawPie e drawChord().

- Disegnare e riempire poligoni generali - drawPolygon().

- Disegnare curve di bezier - drawQuadBezier() [drawCubicBezier in Qt 3.0].

#### Disegnare pixmap e immagini

Qt fornisce due classi molto diverse per rappresentare le immagini.

QPixmap corrisponde direttamente alle pixmap di X11. Le pixmap sono oggetti server-side e possono - su schede grafiche recenti - anche essere memorizzate direttamente nella memoria della scheda. Questo rende molto efficiente trasferire pixmap sullo schermo. Queste fungono anche come un'equivalente dei widget - la classe QPixmap è una sottoclasse di QPaintDevice, quindi la si può disegnare con un QPainter. Le operazioni di disegno elementari sono normalmente accelerate dalle schede grafiche moderne, quindi è un'abitudine comune usare le pixmap per il double buffering. In questo modo, invece di disegnare direttamente su un widget, si disegna su un oggetto pixmap temporaneo e si usa la funzione bitBlt per trasferire la pixmap nel widget. Nelle operazioni di ridisegno più complesse questo può aiutare per evitare gli sfarfalii.

Al contrario, gli oggetti QImage sono client-side. La loro caratteristica consiste nel fornire un accesso diretto ai pixel, che li rende utili per la manipolazione delle immagini e per altre cose come il caricamento e il salvataggio sul disco (il metodo load() di QPixmap riceve un'oggetto QImage come fase intermedia). D'altra parte, dipingere un'immagine su un widget è un'operazione costosa, poichè implica un trasferimento nel server X, che richiede parecchio tempo specialmente con immagini grandi e su server remoti. La conversione da QImage a QPixmap può richiedere anche il dithering, a seconda della profondità del colore.

#### Disegnare testo

Il testo può essere disegnato con una delle versioni sovraccaricate del metodo QPainter::drawText(). Queste disegnano una QString in un certo punto o in un certo rettangolo, usando il font impostato con il metodo QPainter::setFont(). C'è anche un parametro che riceve una combinazione ORed di alcuni flag dell'enumerazione Qt::AlignmentFlags e Qt::TextFlags

Dalla versione 3.0, Qt si occupa della disposizione del testo anche per i linguaggi scritti da destra verso sinistra.

Un sistema più avanzato per visualizzare testo con markup è rappresentato dall'uso della classe QSimpleRichText. Gli oggetti di questa classe possono essere costruiti con del testo che usa un consistente sottoinsieme dei tag HTML, comprendente anche le tabelle. Lo stile del testo può essere personalizzato usando uno QStyleSheet (la documentazione dei tag può essere trovata qui). Una volta che l'oggetto è stato costruito può essere visualizzato su un widget o un altro dispositivo di disegno attraverso il metodo QSimpleRichText::draw().

### Grafica strutturata con QCanvas

QPainter offre un potente modello grafico per dipingere sui widget e sulle pixmap. Tuttavia potrebbe anche essere scomodo da usare, infatti ogni volta che il widget riceve un evento paint deve analizzare la regione (QPaintEvent::region()) o il rettangolo (QPaintEvent::rect()) che deve essere ridisegnato. Dopo deve impostare un QPainter e dipingere tutti gli oggetti che occupano quella regione. Per esempio, si immagini un programma di grafica vettoriale che permette di trascinare oggetti come poligoni o cerchi. Ogni volta che quegli oggetti vengono mossi, il gestore di eventi del mouse del widget solleva un evento paint per l'intera area coperta dagli oggetti nella loro posizione precedente e in quella attuale. Le operazioni di ridisegno necessarie potrebbero essere difficili da capire, da svolgere in modo efficiente e potrebbero entrare in conflitto con la struttura orientata agli oggetti del codice sorgente del programma.

Qt contiene come alternativa la classe QCanvas nella quale si possono inserire oggetti grafici come poligoni, testi e pixmap. Si possono anche usare altri elementi derivando la classe QCanvasItem o una delle sue sottoclassi più specializzate. Un canvas può essere mostrato sullo schermo da uno o più widget della classe QCanvasView che deve essere derivata per poter gestire le interazioni con l'utente. Tutte le operazioni di ridisegno degli oggetti nella visuale causate dalla visualizzazione del widget o dalla creazione di nuovi oggetti o da altri eventi sono gestite da Qt. Usando il double buffering tutto questo può essere effettuato in maniera efficiente e senza sfarfalii.

Gli oggetti canvas possono sovrapporsi gli uni agli altri. In questo caso l'oggetto visibile dipende dall'ordine z, che può essere impostato con QCanvasItem::setZ(). Si possono rendere gli oggetti visibili o invisibili e si può anche fornire uno sfondo che sarà disegnato "dietro" a tutti gli oggetti e un colore di primo piano. Per associare degli eventi del mouse agli oggetti esiste il metodo QCanvas::collisions() che restituisce per un dato punto la lista degli oggetti sovrapposti. Qui c'è uno screenshot di una canvas view:

Qui la rete è disegnata sullo sfondo. Inoltre c'è un oggetto QCanvasText e un QCanvasPolygon violetto. La farfalla è un QCanvasPixmap. Ha delle aree trasparenti attraverso le quali si possono vedere gli oggetti sottostanti.

Un tutorial sull'uso di QCanvas per scrivere giochi basati sugli sprite può essere trovato qui.

### Grafica 3D con OpenGL

#### Interfaccia di basso livello

Al giorno d'oggi lo standard de facto per la visualizzazione della grafica 3D è OpenGL. Le implementazioni di queste specifiche, che spesso supportano l'accelerazione hardware delle schede grafiche moderne, sono disponibili per Microsoft Windows, Mac OS X e XFree86. Di per sè, OpenGL si occupa del rendering di un'area specifica del framebuffer attraverso un GL context e non ha nessun'altra interazione con il toolkit dell'ambiente.

Qt fornisce il widget QGLWidget che incapsula in una finestra un GL context associato ad essa. Fondamentalmente lo si usa derivandolo e reimplementando alcuni metodi.

- Invece della reimplementazione di paintEvent() e dell'uso di QPainter per disegnare i contenuti del widget, si modifica paintGL() e si usano i comandi GL per disegnare una scena. QGLWidget si assicurerà di rendere il suo GL context attuale prima della chiamata a paintGL().

- Il metodo virtuale initializeGL() viene chiamato precedentemente alla prima chiamata a resizeGL() o a paintGL(). Può essere usato per costruire le liste di visualizzazione degli oggetti ed effettuare le inizializzazioni.

- Invece di reimplementare resizeEvent() si modifica resizeGL().Può essere usato per impostare in modo appropriato il viewport.

- Quando lo stato della scena è cambiato - per esempio quando viene animata con un timer - si dovrebbe chiamare updateGL() invece che update(). Questo causerà un'operazione di ridisegno.

In generale il comportamento del QGLWidget è simile a quello degli altri widget, cioè per esempio si possono elaborare gli eventi del mouse come al solito, ridimensionare il widget e combinarlo con altri widget in una certa disposizione.

Qt contiene alcuni esempi sull'uso di QGLWidget nei `demo`. Si possono trovare vari tutorial qui, mentre nella home page di OpenGL sono disponibili ulteriori informazioni e un riferimento a OpenGL.

#### Interfacce di alto livello

OpenGL è un'interfaccia di basso livello per disegnare grafica 3D. Allo stesso modo in cui QCanvas fornisce al programmatore un'interfaccia di alto livello che gestisce gli oggetti e le loro proprietà, esistono interfacce di alto livello anche per la grafica 3D. Una delle più popolari è Open Inventor. Tecnologia originalmente sviluppata da SGI, oggi è disponibile con l'implementazione open source Coin, integrata da un toolkit per Qt chiamato SoQt.

Il concetto fondamentale in Open Inventor è la scena. Una scena può essere caricata dal disco e salvata in un formato speciale molto simile al VRML. Essa consiste di una collezione di oggetti chiamati node. Inventor fornisce una ricca collezione di node riutilizzabili, come cubi, cilindri e reti, oltre a sorgenti di luce, materiali, telecamere, ecc. I node sono rappresentati da classi C++ e possono essere derivati e combinati.

Un'introduzione a Inventor può essere trovata qui (generalmente in questo articolo si possono sostituire tutti i riferimenti a SoXt con SoQt).

## Interfacce utente

### Il pattern action

### Definire i menu e le barre degli strumenti in XML

#### Introduzione

Il pattern action, mentre permette di incapsulare le azioni attivate dall'utente in un oggetto che può essere "collegato" da qualche parte nelle barre dei menu o nelle barre degli strumenti, non risolve di per sè il problema della costruzione dei menu stessi. In particolare, si devono costruire tutti i menu a comparsa in codice C++ ed inserire esplicitamente le azioni in un certo ordine, tenendo presente la guida sullo stile per le azioni standard. Questo rende piuttosto difficile per l'utente personalizzare i menu o cambiare le scorciatoie a seconda delle sue necessità senza cambiare il codice sorgente.

Questo problema è stato risolto usando un insieme di classi chiamate `XMLGUI`. Fondamentalmente vengono separate le azioni (codificate in C++) dalla loro rappresentazione nelle barre dei menu e nelle barre degli strumenti (codificate in XML). I menu possono essere personalizzati attraverso un file XML senza modificare il codice sorgente.In questo modo le azioni standard (come File Apri o Aiuto Informazioni) appariranno nelle posizioni indicate nella guida allo stile. XMLGUI è particolarmente importante per i programmi modulari, dove gli oggetti che appaiono nella barra dei menu possono provenire da diversi plugin o componenti.

La classe KDE per le finestre toplevel, KMainWindow, eredita da KXMLGUIClient, e quindi supporta direttamente XMLGUI. Tutte le azioni create al suo interno devono avere come genitore il valore `actionCollection()`. In seguito la chiamata a `createGUI()` costruirà l'intero insieme di menu e barre degli strumenti definito nel file XML dell'applicazione (che ha convenzionalmente il suffisso `ui.rc`).

#### Un esempio: i menu di KView

Di seguito si considererà come esempio il visualizzatore di immagini di KDE KView. Esso ha un file `ui.rc` chiamato `kviewui.rc` che viene installato con la seguente parte del file `Makefile.am`

    rcdir = $(kde_datadir)/kview
    rc_DATA = kviewui.rc

Ecco un pezzo tratto dal file `kviewui.rc`. Per semplicità verrà mostrata solo la definizione del menu View.

    <!DOCTYPE kpartgui>
    <kpartgui name="kview">
      <MenuBar>
        <Menu name="view" >
          <Action name="zoom50" />
          <Action name="zoom100" />
          <Action name="zoom200" />
          <Action name="zoomMaxpect" />
          <Separator/>
          <Action name="fullscreen" />
        </Menu>
      </MenuBar>
    </kpartgui>

Il codice C++ corrispondente è:

    KStdAction::zoomIn    ( this, SLOT(slotZoomIn()), actionCollection() );
      KStdAction::zoomOut   ( this, SLOT(slotZoomOut()), actionCollection() );
      KStdAction::zoom      ( this, SLOT(slotZoom()), actionCollection() );
      new KAction           ( i18n("&Half size"), ALT+Key_0,
                              this, SLOT(slotHalfSize()),
                              actionCollection(), "zoom50" );
      new KAction           ( i18n("&Normal size"), ALT+Key_1,
                              this, SLOT(slotDoubleSize()),
                              actionCollection(), "zoom100" );
      new KAction           ( i18n("&Double size"), ALT+Key_2,
                              this, SLOT(slotDoubleSize()),
                              actionCollection(), "zoom200" );
      new KAction           ( i18n("&Fill Screen"), ALT+Key_3,
                              this, SLOT(slotFillScreen()),
                              actionCollection(), "zoomMaxpect" );
      new KAction           ( i18n("Fullscreen &Mode"), CTRL+SHIFT+Key_F,
                              this, SLOT(slotFullScreen()),
                              actionCollection(), "fullscreen" );

Il menu View risultante da questa definizione di GUI assomiglia a questo screenshot:

Il file XML inizia con una dichiarazione del tipo di documento (Document Type Declaration, DTD). Il DTD per kpartgui può essere trovato nei sorgenti di kdelibs in `kdeui/kpartgui.dtd`. L'elemento più esterno del file contiene come attributo il nome dell'istanza dell'applicazione. Contiene anche un numero di versione nella forma "version=2", che è utile quando si rilasciano nuove versioni di un'applicazione che hanno una struttura differente dei menu, ad esempio con più voci. Se si aumenta il numero della versione nel file `ui.rc`, KDE si assicurerà che vengano scartate tutte le versioni personalizzate del file e che venga usato il nuovo file al loro posto.

La linea successiva, `<MenuBar>`, contiene la dichiarazione di una barra dei menu. Si può inserire un qualsiasi numero di dichiarazioni `<ToolBar>` per creare diverse barre degli strumenti. Il menu contiene un sottomenu di nome "view". Questo nome è già predefinito e quindi si vedrà la traduzione della parola "View" nello screenshot. Se si dichiarano dei propri sottomenu si deve aggiungere il loro titolo esplicitamente. Per esempio, KView ha un sottomenu con il titolo "Image", che è dichiarato come segue:

    <Menu name="image" >
       <text>&amp;Image</text>
       ...
    </Menu>

Nel framework KDE questi titoli vengono automaticamente estratti ed inseriti nel file `.po` dell'applicazione, in modo da essere esaminati dai traduttori. Notare che si deve scrivere il simbolo dell'acceleratore "&" nella forma compatibile con XML "&amp;".

Ritornando all'esempio, il menu View di KView contiene un paio di azioni personalizzate: `zoom50`, `zoom100`, `zoom200`, `zoomMaxpect` e`fullscreen`, dichiarate con un elemento `<Action>`. Il separatore negli screenshot corrisponde all'elemento `<Separator>`.

Si noterà che alcune voci di menu non hanno un corrispondente nel file XML. Queste sono le azioni standard. Esse sono create dalla classe KStdAction. Quando si creano tali azioni nell'applicazione (come nel precedente esempio in C++), saranno automaticamente inserite in una locazione predefinita, eventualmente associate ad un'icona e ad una scorciatoria da tastiera. Si possono vedere queste locazioni nel file `kdeui/ui_standards.rc` nei sorgenti di kdelibs.

#### Un esempio: le barre degli strumenti di Konqueror

Per analizzare le barre degli strumenti si esamineranno le definizioni della GUI di Konqueror. Questo estratto definisce la barra degli indirizzi, che contiene il campo di input per gli URL.

    <ToolBar name="locationToolBar" fullWidth="true" newline="true" >
      <text>Location Toolbar</text>
      <Action name="clear_location" />
      <Action name="location_label" />
      <Action name="toolbar_url_combo" />
      <Action name="go_url" />
    </ToolBar>

La prima cosa che si può notare è la maggiore quantità di attributi rispetto a quelli nelle barre dei menu. Questi comprendono:

- `fullWidth`: indica a XMLGUI che la barra degli strumenti deve avere la stessa larghezza della finestra toplevel. Se è impostato su "false" la barra degli strumenti occuperà solo lo spazio necessario e le altre barre degli strumenti saranno inserite nella stessa riga.

- `newline`: questo è relativo all'opzione di cui sopra. Se è "true", la barra degli strumenti comparirà su una nuova riga. Altrimenti può essere messa nella riga assieme alle barre precedenti.

- `noEdit`: normalmente le barre degli strumenti possono essere personalizzate dall'utente, ad esempio in Konqueror attraverso Impostazioni Configura le barre degli strumenti.... Impostando questa opzione su "true" si segna questa barra degli strumenti come non modificabile. Questo è importante per le barre che sono riempite con oggetti a runtime, ad esempio la barra dei segnalibri di Konqueror.

- `iconText`: indica a XMLGUI di mostrare il testo dell'azione vicino all'icona. Normalmente, il testo viene mostrato solo come suggerimento quando il cursore del mouse rimane per un po' sopra all'icona. I valori possibili per questo attributo sono "icononly" (mostra solo l'icona), "textonly" (mostra solo il testo), "icontextright" (mostra il testo nella parte destra dell'icona), "icontextbottom" (mostra il testo sotto all'icona).

- `hidden`: se questo attributo è "true", la barra degli strumenti non sarà inizialmente visibile e dovrà essere attivata da qualche voce di menu.

- `position`: il valore predefinito è "top", che corrisponde al posizionamento della barra degli strumenti sotto la barra dei menu. Per programmi che possiedono molte barre degli strumenti, come i programmi di grafica, può essere interessante cambiare il valore in "left", "right" o "bottom".

#### Menu dinamici

Ovviamente, un file XML può contenere solo una descrizione statica dell'interfaccia utente. Spesso si possono trovare menu che cambiano a runtime. Per esempio il menu contestuale di Konqueror contiene una serie di voci del tipo Apri con e il nome dell'applicazione capace di caricare il file con quel tipo MIME. Ogni volta che il documento mostrato cambia, viene aggiornata la lista delle voci del menu. XMLGUI può gestire questi casi con le liste di azioni. Una lista di azioni è dichiarata come un singolo oggetto nel file XML, ma è costituita da diverse azioni che sono collegate nel menu a runtime. L'esempio sopra è implementato con queste dichiarazioni nel file XML di Konqueror:

    <Menu name="file">
      <text>&amp;Location</text>
      ...
      <ActionList name="openwith">
      ...
    </Menu>

La funzione `KXMLGUIClient::plugActionList()` è usata in seguito per aggiungere azioni da visualizzare, mentre la funzione `KXMLGuiClient::unplugActionList()` rimuove tutte le azioni collegate. La routine che aggiorna le visualizzazioni è simile a questa:

    void MainWindow::updateOpenWithActions()
    {
        unplugActionList("openwith");
        openWithActions.clear();
        for ( /* iterate over the relevant services */ ) {
            KAction *action = new KAction( ...);
            openWithActions.append(action);
        }
        plugActionList("openwith", openWithActions);
    }

Notare che, al contrario delle azioni statiche, quelle create qui non sono costruite con l'action collection come genitore e si è responsabili della loro distruzione. La via più semplice per fare questo è usare `openWithActions.setAutoDelete(true)`.

#### Menu contestuali

Gli esempi sopra citati consistono di casi dove vengono create una barra dei menu e una barra degli strumenti della finestra principale. In questi casi il processo di costruzione dei contenitori è completamente nascosto dietro la chiamata alla funzione `createGUI()` (a meno che non si abbiano contenitori personalizzati). Tuttavia talvolta si vogliono costruire altri contenitori e riempirli con le definizioni dal file XML, come ad esempio nei menu contestuali. Un puntatore ad un menu contestuale può essere ottenuto dalla factory:

    void MainWindow::popupRequested()
    {
        QWidget *w = factory()->container("context_popup", this);
        QPopupMenu *popup = static_cast<QPopupMenu *>(w);
        popup->exec(QCursor::pos());
    }

Il metodo `KXMLGUIFactory::container()` usato sopra controlla se si trova un contenitore nel file XML corrispondente al nome fornito. Quindi, una possibile definizione è questa:

    ...
    <Menu name="context_popup">
      <Action name="file_add"/>
      <Action name="file_remove"/>
    </Menu>
    ...

### Fornire aiuto online

Rendere un programma facile e intuitivo coinvolge un'ampia gamma di funzioni che vengono generalmente chiamate aiuto online. Esse hanno diversi obiettivi, a volte in conflitto tra loro: da un lato dovrebbero fornire all'utente le risposte alle domande del tipo "Come posso fare un certo lavoro?", dall'altro lato dovrebbero aiutare l'utente nell'esplorazione del programma e nella ricerca delle funzioni che non conosce. È importante capire che questi obiettivi possono essere raggiunti solo offrendo diversi livelli di aiuto:

- I suggerimenti sono piccole etichette che appaiono sugli elementi dell'interfaccia utente quando il mouse si sofferma su di essi a lungo. Sono particolarmente importanti per le barre degli strumenti, dove le icone non sono sempre sufficienti nel rappresentare lo scopo di un pulsante.

- L'aiuto "Che cos'è?" consiste generalmente in una spiegazione più lunga e dettagliata di un widget o di una voce di menu. È anche più scomodo da usare: nelle finestre di dialogo può essere attivato in due modi: premendo Shift F1 o facendo clic sul punto interrogativo nella barra del titolo (quest'ultima caratteristica potrebbe non essere supportata dal proprio window manager). Il puntatore del mouse assume la forma di una freccia con un punto interrogativo e quando viene fatto clic su un elemento dell'interfaccia utente appare la finestra di aiuto. L'aiuto "Che cos'è?" per le voci di menu viene generalmente attivato da un pulsante della barra degli strumenti che contiene una freccia e un punto interrogativo.

- Il problema di questo approccio consiste nel fatto che l'utente non può vedere se un widget fornisce aiuto o no. Quando l'utente attiva il pulsante con il punto interrogativo e facendo clic su un elemento dell'interfaccia utente non ottiene la finestra di aiuto può restare presto deluso.

  Il vantaggio della finestra di aiuto "Che cos'è?" fornita da Qt e KDE consiste nella possibilità di contenere rich text, ovvero può contenere diversi font, testo in grassetto e corsivo e anche tabelle e immagini.

  Un esempio di aiuto "Che cos'è?":

- Infine, tutti i programmi dovrebbero avere un manuale. Un manuale viene normalmente visualizzato in KHelpCenter attraverso l'attivazione del menu Aiuto. Questo implica la comparsa di una nuova applicazione che distrae l'utente dal suo lavoro. Di conseguenza la consultazione del manuale dovrebbe essere necessaria solo se tutte le altre funzioni di aiuto come i suggerimenti e il Che cos'è? non sono sufficienti. Ovviamente un manuale non spiega aspetti singoli ed isolati dell'interfaccia utente, ma li illustra in un contesto più ampio. I manuali di KDE sono scritti con il linguaggio di markup DocBook.

Dal punto di vista del programmatore, Qt fornisce un API facile da usare per l'aiuto online. Per assegnare un suggerimento ad un widget si usa la classe QToolTip.

    QToolTip::add(w, i18n("Questo widget fa qualcosa."))

Se la barra dei menu e la barra degli strumenti sono costruite usando il pattern action, le stringhe usate per i suggerimenti sono derivate dal primo argomento del costruttore di KAction:

    action = new KAction(i18n("&Delete"), "editdelete",
                         SHIFT+Key_Delete, actionCollection(), "del")

Qui è anche possibile assegnare un testo che viene mostrato nella barra di stato quando viene evidenziata la voce di menu corrispondente:

    action->setStatusText(i18n("Cancella il file segnato"))

L'API per l'aiuto "Che cos'è?" è molto simile. Nelle finestre di dialogo usare il codice seguente:

    QWhatsThis::add(w, i18n("<qt>This demonstrates <b>Qt</b>'s"
                            " rich text engine.<ul>"
                            "<li>Foo</li>"
                            "<li>Bar</li>"
                            "</ul></qt>"))

Per le voci di menu usare

    action->setWhatsThis(i18n("Cancella il file segnato"))

La chiamata a KHelpCenter è incapsulata nella classe KApplication. Per visualizzare il manuale della propria applicazione, usare

    kapp->invokeHelp()

Questo mostra la prima pagina con l'indice dei contenuti. Quando si vuole visualizzare solo una particolare sezione del manuale, si può fornire un argomento aggiuntivo alla funzione `invokeHelp()` che indica la posizione che si vuole far visualizzare dal browser.

## Componenti e servizi

### Servizi KDE

#### Cosa sono i servizi di KDE?

La nozione di servizio è un concetto fondamentale nell'architettura modulare di KDE. Non sono previste strette implementazioni tecniche - i servizi possono essere plugin sotto forma di librerie condivise o possono essere programmi controllati attraverso DCOP. Un servizio deve assicurare l'implementazione di alcune API o funzioni per poter affermare la propria appartenenza ad un certo tipo di servizio. Nel gergo del C++, si può pensare ad un tipo di servizio come una classe astratta e ad un servizio come alla sua implementazione.

Il vantaggio della separazione è chiaro: un'applicazione che utilizza un tipo di servizio non deve conoscere nulla sulle possibili implementazioni di esso. Userà solo le API associate al tipo di servizio. In questo modo il servizio usato può essere sostituito senza ripercussioni sull'applicazione. Inoltre l'utente può configurare quali servizi preferisce per alcune funzioni.

Alcuni esempi:

- Il motore di rendering HTML usato in Konqueror è un componente integrabile che implementa i tipi di servizio `KParts/ReadOnlyPart` e `Browser/View`.

- Molte funzionalità di KDevelop sono contenute in plugin che hanno come tipo di servizio `KDevelop/Part`. All'avvio vengono caricati tutti i servizi di questo tipo, in modo da poter estendere l'IDE in maniera molto flessibile.

- La vista a icone di Konqueror - se abilitata - mostra i thumbnail dei file di immagini, delle pagine HTML, PDF e del testo. Questa caratteristica può essere ampliata. Se si vuole visualizzare le anteprime dei propri file di dati che possiedono qualche tipo MIME si può implementare un servizio usando il tipo di servizio `ThumbCreator`.

Ovviamente un servizio non è caratterizzato solo dal tipo di servizio che implementa, ma anche da alcune proprietà. Per esempio, un ThumbCreator non deve solo affermare di implementare la classe C++ con il tipo `ThumbCreator`, ma deve anche avere un elenco di tipi MIME di cui è responsabile. Similmente i componenti di KDevelop hanno come proprietà il linguaggio di programmazione supportato. Quando un'applicazione richiede un tipo di servizio, può anche elencare nelle proprietà del servizio dei vincoli. Nell'esempio sopra, quando KDevelop carica i plugin per un progetto Java, chiede solo i plugin che hanno come proprietà il linguaggio di programmazione Java. Per questo scopo, KDE include un completo trader tipo CORBA con un complesso linguaggio per le query.

#### Definire i tipi di servizio

I nuovi tipi di servizio sono aggiunti installando una loro descrizione nella directory `KDEDIR/share/servicetypes`. In un framework automake l'installazione può essere fatta con questo frammento del file `Makefile.am`:

    kde_servicetypesdir_DATA = kdeveloppart.desktop
    EXTRA_DIST = $(kde_servicetypesdir_DATA)

La definizione `kdeveloppart.desktop` di un componente di KDevelop è simile a questa:

    [Desktop Entry]
    Type=ServiceType
    X-KDE-ServiceType=KDevelop/Part
    Name=KDevelop Part

    [PropertyDef::X-KDevelop-Scope]
    Type=QString

    [PropertyDef::X-KDevelop-ProgrammingLanguages]
    Type=QStringList

    [PropertyDef::X-KDevelop-Args]
    Type=QString

In aggiunta alle voci normali, questo esempio mostra come dichiarare un servizio che ha alcune proprietà. Ogni definizione di proprietà corrisponde al gruppo `[PropertyDef::name]` nel file di configurazione. La voce `Type` di questo gruppo dichiara il tipo della proprietà. I tipi possibili sono tutti quelli che possono essere memorizzati in un QVariant.

#### Definire servizi con librerie condivise

Le definizioni dei servizi sono memorizzate nella directory `KDEDIR/share/services`:

    kde_servicesdir_DATA = kdevdoxygen.desktop
    EXTRA_DIST = $(kde_servicesdir_DATA)

Il contenuto del seguente file di esempio `kdevdoxygen.desktop` definisce il plugin `KDevDoxygen` con il tipo di servizio `KDevelop/Part`:

    [Desktop Entry]
    Type=Service
    Comment=Doxygen
    Name=KDevDoxygen
    ServiceTypes=KDevelop/Part
    X-KDE-Library=libkdevdoxygen
    X-KDevelop-ProgrammingLanguages=C,C++,Java
    X-KDevelop-Scope=Project

Oltre le normali dichiarazioni, un elemento importante è `X-KDE-Library`. Questo contiene il nome della libreria libtool (senza l'estensione `.la`). Esso stabilisce anche il nome del simbolo esportato nella libreria che restituisce un oggetto factory (con il prefisso `init_`). Per l'esempio precedente, la libreria deve contenere la seguente funzione:

    extern "C" {
        void *init_libkdevdoxygen()
        {
            return new DoxygenFactory;
        }
    };

Il tipo della classe factory `DoxygenFactory` dipende dal tipo specifico del servizio che viene implementato. Nel nostro esempio del plugin di KDevelop, il factory deve essere un `KDevFactory` (che eredita da `KLibFactory`). Altri esempi comuni sono KParts::Factory che si presuppone che produca oggetti KParts::ReadOnlyPart o nella maggior parte dei casi il generico KLibFactory.

#### Usare i servizi con librerie condivise

Per usare un servizio con una libreria condivisa in una applicazione, si deve ottenere un oggetto KService che lo rappresenta. Questo è discusso nella sezione sui tipi MIME (e in una sezione sul trader ancora da scrivere :-)

Con un oggetto `KService` si può semplicemente caricare la libreria e ottenere un puntatore al suo oggetto factory:

    KService *service = ...
    QString libName = QFile::encodeName(service->library());
    KLibFactory *factory = KLibLoader::self()->factory(libName);
    if (!factory) {
        QString name = service->name();
        QString errorMessage = KLibLoader::self()->lastErrorMessage();
        KMessageBox::error(0, i18n("There was an error loading service %1.\n"
                                   "The diagnostics from libtool is:\n%2")
                              .arg(name).arg(errorMessage);
    }

A questo punto, i passi successivi dipendono come sempre dal tipo di servizio. Per i plugin generici vengono creati gli oggetti con il metodo KLibFactory::create(). Per KParts si deve effettuare il cast del puntatore all'oggetto factory al più specifico KParts::Factory e usare il suo metodo create():

    if (factory->inherits("KParts::Factory")) {
        KParts::Factory *partFactory = static_cast<KParts::Factory*>(factory);
        QObject *obj = partFactory->createPart(parentWidget, widgetName,
                                               parent, name, "KParts::ReadOnlyPart");
        ...
    } else {
        cout << "Service does not implement the right factory" << endl;
    }

#### Definire servizi DCOP

Un servizio DCOP è normalmente implementato come un programma che viene avviato quando è necessario. In seguito esso inizia un ciclo dove attende le connessioni DCOP. Il programma può essere interattivo, ma può anche essere eseguito completamente o parzialmente come un demone in background senza che l'utente lo noti. Un esempio di un tale demone è `kio_uiserver`, che implementa l'interazione con l'utente come una finestra di avanzamento per la libreria KIO. Il vantaggio di un demone centralizzato consiste ad esempio nel poter mostrare in una finestra gli avanzamenti del download di diversi file anche se questi sono stati avviati da diverse applicazioni.

Un servizio DCOP è definito diversamente da un servizio di una libreria condivisa. Ovviamente esso non specifica una libreria ma un eseguibile. Inoltre i servizi DCOP non dichiarano una linea ServiceType poiché normalmente vengono avviati con il loro nome. Contiene due linee aggiuntive:

`X-DCOP-ServiceType` indica il modo con cui il servizio viene avviato. Il valore `Unique` indica che il servizio non può essere avviato più di una volta. Questo significa che se si tenta di avviare il servizio (ad es. attraverso KApplication::startServiceByName()) KDE controllerà se è già stato registrato con DCOP e userà il servizio in esecuzione. In caso contrario lo avvierà e attenderà fino alla sua registrazione. In seguito si potranno immediatamente inviare chiamate DCOP al servizio. In questo caso, il servizio dovrebbe essere implementato come KUniqueApplication.

Il valore `Multi` del parametro `X-DCOP-ServiceType` indica che possono coesistere istanze multiple del servizio, quindi ogni tentativo di avviare il servizio creerà un nuovo processo. Come ultima possibilità può essere usato il valore `None`. In questo caso, l'avvio del servizio non attenderà la registrazione con DCOP.

`X-KDE-StartupNotify` dovrebbe normalmente essere impostato su false. In caso contrario, quando il programma viene avviato, la barra delle applicazioni mostrerà la notifica di avvio o, a seconda delle impostazioni dell'utente, verrà cambiato il cursore.

Ecco la definizione di `kio_uiserver`:

    [Desktop Entry]
    Type=Service
    Name=kio_uiserver
    Exec=kio_uiserver
    X-DCOP-ServiceType=Unique
    X-KDE-StartupNotify=false

#### Usare i servizi DCOP

Un servizio DCOP è avviato con uno dei vari metodi della classe KApplication:

    DCOPClient *client = kapp->dcopClient();
    client->attach();
    if (!client->isApplicationRegistered("kio_uiserver")) {
        QString error;
        if (KApplication::startServiceByName("kio_uiserver", QStringList(), &error))
            cout << "Starting kioserver failed with message " << error << endl;
    }
    ...
    QByteArray data, replyData;
    QCString replyType;
    QDataStream arg(data, IO_WriteOnly);
    arg << true;
    if (!client->call("kio_uiserver", "UIServer", "setListMode(bool)",
                      data, replyType, replyData))
        cout << "Call to kio_uiserver failed" << endl;
    ...

Notare che in questo esempio di chiamata DCOP usa il marshalling esplicito degli argomenti. Spesso si vorrà invece usare uno stub creato da dcopidl2cpp , perché è più semplice e meno soggetto ad errori.

In questo esempio il servizio è stato avviato "con il nome", cioè il primo argomento della funzione `KApplication::startServiceByName()` è il nome che appare nella linea `Name` del file desktop. In alternativa si può usare la funzione `KApplication::startServiceByDesktopName()`, che accetta come argomento il nome del suo file desktop, in questo caso `"kio_uiserver.desktop"`.

Tutte queste chiamate ricevono come secondo argomento una lista di URL, che viene passata al servizio a linea di comando. Il terzo argomento è un puntatore ad una `QString`. Se l'avvio del servizio non riescequesto argomento punta ad un messaggio di errore.

### Tipi MIME

#### Cosa sono i tipi MIME?

I tipi MIME sono usati per descrivere il tipo di contenuto di file o blocchi di dati. Originalmente vennero introdotti per permettere l'invio di immagini o file audio attraverso l'email (MIME significa "Multipurpose Internet Mail Extensions"). In seguito questo sistema venne usato dai browser web per determinare come rappresentare i dati inviati da un server web all'utente. Per esempio, una pagina HTML ha un tipo MIME "text/html", mentre un file postscript è del tipo "application/postscript". In KDE questo sistema viene usato in vari ambiti:

- Nella vista a icone di Konqueror i file sono rappresentati da icone. Ogni tipo MIME ha un'icona associata.

- Quando in Konqueror si fa clic sull'icona di un file o sul nome di un file, esso viene visualizzato nella vista incorporata o viene aperta un'applicazione associata con il tipo di file.

- Quando si effettua il drag and drop con alcuni dati da un'applicazione all'altra (o all'interno della stessa), il destinatario può scegliere di accettare solo alcuni tipi di dati. Inoltre i dati immagine verranno gestiti in modo differente rispetto ai dati testuali.

- I dati degli appunti hanno un tipo MIME. Tradizionalmente i programmi X possono gestire solo pixmap o testi, ma con Qt non ci sono limitazioni sui tipi di dati.

Dagli esempi sopra appare chiara la complessità del problema relativo alla gestione dei tipi MIME. Innanzitutto è necessario stabilire una mappa tra i nomi dei file e i tipi MIME. KDE si spinge oltre permettendo anche la mappatura dei contenuti dei file, in caso non sia disponibile il nome. Poi è necessario mappare i tipi MIME con le applicazioni o le librerie che possono visualizzare o modificare un file di un dato tipo o creare un thumbnail.

Ci sono diverse API per capire il tipo MIME di dati o file. Generalmente si deve effettuare un bilanciamento tra velocità e attendibilità. Si può trovare il tipo di un file esaminando solo il suo nome (nella maggior parte dei casi la sua estensione). Per esempio un file `foo.jpg` normalmente è del tipo "image/jpeg". In caso l'estensione sia mancante si deve di fatto controllare il contenuto del file. Questo risulta ovviamente più lento, in particolare se il file deve essere prima scaricato attraverso HTTP. Il metodo basato sul contenuto si basa sul file `KDEDIR/share/mimelnk/magic` ed è quindi difficile da estendere, ma generalmente le informazioni sul tipo MIME possono essere rese facilmente disponibili al sistema installando un file `desktop` e sono disponibili in modo efficiente e conveniente attraverso le librerie KDE.

#### Definire i tipi MIME

Definiamo un tipo `"application/x-foo"` per l'applicazione foobar. Si deve scrivere un file `foo.desktop` ed installarlo in `KDEDIR/share/mimelnk/application`. (Questa è la posizione normale, che potrebbe variare a seconda della distribuzione). Può essere fatto aggiungendo questo al file `Makefile.am`:

    mimedir = $(kde_mimedir)/application
    mime_DATA = foo.desktop
    EXTRA_DIST = $(mime_DATA)

Il file `foo.desktop` dovrebbe essere simile a questo:

    [Desktop Entry]
    Type=MimeType
    MimeType=application/x-foo
    Icon=fooicon
    Patterns=*.foo;
    DefaultApp=foobar
    Comment=Foo Data File
    Comment[de]=Foo Datei

La voce `"Comment"` è destinata ad essere tradotta. Siccome il file `.desktop` specifica un'icona, si dovrebbe installare un'icona `fooicon.png` che rappresenta il file ad esempio in Konqueror.

Nelle librerie KDE, una tale definizione di tipo è mappata con una istanza della classe KMimeType. Usarla come nel seguente esempio:

    KMimeType::Ptr type = KMimeType::mimeType("application/x-foo");
    cout << "Type:    " << type->name() < endl;
    cout << "Icon:    " << type->icon() < endl;
    cout << "Comment: " << type->icon() < endl;
    QStringList patterns = type->patterns();
    QStringList::ConstIterator it;
    for (it = patterns.begin(); it != patterns.end(); ++it)
      cout << "Pattern: " << (*it) << endl;

#### Determinare il tipo MIME dei dati

Il metodo veloce per determinare il tipo di un file è la funzione `KMimeType::findByURL()`. Viene cercata la stringa dell'URL e nella maggior parte dei casi viene determinato il tipo dall'estensione. Questo meccanismo non viene usato con alcuni protocolli (ad es. http, man, info). Per esempio gli script CGI scritti in Perl hanno spesso l'estensione `.pl` che indica un tipo `"text/x-perl"`. Tuttavia il file inviato dal server è l'output di questo script, che normalmente è HTML. In questo caso la funzione `KMimeType::findByURL()` restituisce il tipo MIME `"application/octet-stream"` (disponibile attraverso `KMimeType::defaultMimeType()`) che indica il fallimento della ricerca del tipo.

    KMimeType::Ptr type = KMimeType::findByURL("/home/bernd/foobar.jpg");
    if (type->name() == KMimeType::defaultMimeType())
        cout << "Could not find out type" << endl;
    else
        cout << "Type: " << type->name() << endl;

(questo metodo ha altri argomenti, ma questi non sono documentati, quindi vengono semplicemente tralasciati).

Si potrebbe voler trovare un tipo MIME dai contenuti di un file invece che dal nome. Questo sistema è più affidabile ma anche più lento, siccome richiede la lettura di una parte del file. Questo viene fatto con la classe KMimeMagic che ha diverse gestioni di errore:

    KMimeMagicResult *result = KMimeMagic::self()->findFileType("/home/bernd/foobar.jpg");
    if (!result || !result->isValid())
        cout << "Could not find out type" << endl;
    else
        cout << "Type: " << result->mimeType() << endl;

Come variante di questa funzione, si può anche determinare il tipo di un blocco di memoria. Questo viene usato ad es. in Kate per trovare la modalità evidenziata:

    QByteArray array;
    ...
    KMimeMagicResult *result = KMimeMagic::self()->findBufferType(array);
    if (!result || !result->isValid())
        cout << "Could not find out type" << endl;
    else
        cout << "Type: " << result->mimeType() << endl;

Ovviamente anche KMimeMagic è in grado di determinare solo il tipo del file dai contenuti di un file locale. Per i file remoti esiste un'ulteriore possibilità:

    KURL url("http://developer.kde.org/favicon.ico");
    QString type = KIO::NetAccess::mimetype(url);
    if (type == KMimeType::defaultMimeType())
        cout << "Could not find out type" << endl;
    else
        cout << "Type: " << type << endl;

Questo avvia un job di KIO che scaricherà una porzione del file e la controllerà. Notare che questa funzione può essere lenta e bloccare il programma. Normalmente si vorrà usarla solo se la funzione `KMimeType::findByURL()` restituisce `"application/octet-stream"`.

Dall'altro lato se non si vuole bloccare l'applicazione, si può anche avviare esplicitamente il job di KIO e connettere alcuni dei suoi segnali:

    void FooClass::findType()
    {
        KURL url("http://developer.kde.org/favicon.ico");
        KIO::MimetypeJob *job = KIO::mimetype(url);
        connect( job, SIGNAL(result(KIO::Job*)),
                 this, SLOT(mimeResult(KIO::Job*)) );
    }

    void FooClass::mimeResult(KIO::Job *job)
    {
        if (job->error())
            job->showErrorDialog();
        else
            cout << "MIME type: " << ((KIO::MimetypeJob *)job)->mimetype() << endl;
    }

#### Mappare un tipo MIME con un'applicazione o un servizio

Quando viene installata un'applicazione, essa installa un file `.desktop` che contiene una lista dei tipi MIME che possono essere caricati da questa applicazione. Similmente i componenti come KPart rendono disponibile questa informazione attraverso i loro file `.desktop`. In questo modo generalmente esistono diversi programmi e componenti che possono elaborare un certo tipo MIME. Si può ottenere una tale lista dalla classe `KServiceTypeProfile`:

    KService::OfferList offers = KServiceTypeProfile::offers("text/html", "Application");
    KService::OfferList::ConstIterator it;
    for (it = offers.begin(); it != offers.end(); ++it) {
        KService::Ptr service = (*it);
        cout << "Name: " << service->name() << endl;
    }

Il valore restituito da questa funzione corrisponde ad una lista di servizi offerti. Un oggetto `KServiceOffer` impacchetta un KService::Ptr con un numero di preferenza. L'elenco restituito da `KServiceTypeProfile::offers()` è ordinato a seconda delle preferenze dell'utente. Quest'ultimo può cambiarla chiamando `"keditfiletype text/html"` o scegliendo Modifica il tipo di file dal menu contestuale di Konqueror .

Nell'esempio sopra è stato richiesto un elenco delle applicazioni che supportano `text/html`. Questo - tra l'altro - conterrà gli editor HTML come Quanta Plus. Si può anche sostituire il secondo argomento `"Application"` con `"KParts::ReadOnlyPart"`. In questo caso si avrà una lista di componenti integrate per la visualizzazione dei contenuti HTML come ad esempio KHTML.

Nella maggior parte dei casi, non si è interessati all'elenco di tutti i servizi offerti per una data combinazione di tipo MIME e tipo di servizio. Esiste una specifica funzione che fornisce solo il servizio che ha la preferenza più alta:

    KService::Ptr offer = KServiceTypeProfile::preferredService("text/html", "Application");
    if (offer)
        cout << "Name: " << service->name() << endl;
    else
        cout << "No appropriate service found" << endl;

Per query più complesse, c'è un completo trader tipo CORBA.

Per avviare un servizio con alcuni URL, usare KRun:

    KURL::List urlList;
    urlList << "http://www.ietf.org/rfc/rfc1341.txt?number=1341";
    urlList << "http://www.ietf.org/rfc/rfc2046.txt?number=2046";
    KRun::run(offer.service(), urlList);

#### Varie

In questa sezione si elencheranno alcune API che sono meno attinenti alla discussione precedente.

Ottenere un'icona da un URL. Viene cercato il tipo dell'URL e viene restituita l'icona associata.

    KURL url("ftp://ftp.kde.org/pub/incoming/wibble.c");
    QString icon = KMimeType::iconForURL(url);

Avviare un URL. Viene cercato il tipo dell'URL e viene avviato il programma preferito dall'utente associato a questo tipo.

    KURL url("http://dot.kde.org");
    new KRun(url);

### Trasparenza del network

#### Introduzione

Nell'era del world wide web è di fondamentale importanza che le applicazioni desktop possano accedere alle risorse su internet: devono essere in grado di scaricare file da un server web, scrivere file su un server ftp o leggere le email da un server web. Spesso la capacità di accedere ai file indipendentemente dalla loro posizione viene detta trasparenza del network.

Per raggiungere questo obiettivo in passato vennero implementati diversi approcci. Il vecchio file system NFS è un tentativo di implementare la trasparenza del network a livello delle API POSIX. Mentre questo sistema funziona bene su reti locali e strettamente legate, non c'è scalabilità per le risorse il cui accesso è inaffidabile e lento. Qui è importante l'asincronismo. L'interfaccia utente non si dovrebbe bloccare mentre si sta aspettando di scaricare una pagina dal browser. Inoltre la visualizzazione della pagina non dovrebbe iniziare quando la pagina è disponibile completamente, ma dovrebbe aggiornarsi regolarmente man mano che arrivano i dati.

Nelle librerie KDE la trasparenza del network viene implementata nelle API di KIO. Il concetto principale di questa architettura è il job IO. Un job può copiare o cancellare file e cose simili. Quando un job viene avviato lavora sullo sfondo e non blocca l'applicazione. Tutte le comunicazioni dal job all'applicazione - come l'invio di dati o le informazioni sull'avanzamento - sono integrate nell'event loop di Qt.

Le operazioni sullo sfondo vengono svolte avviando degli ioslave per compiere alcuni compiti. Gli ioslave vengono eseguiti come processi separati e comunicano attraverso i socket UNIX. In questo modo non è necessario alcun multi threading e gli ioslave instabili non mandano in crash l'applicazione che li utilizza.

Le posizioni dei file sono espresse dagli usatissimi URL. In KDE non espandono solo l'ambito dei file indirizzabili oltre al file system locale, ma vanno anche nella direzione opposta - ad es. si può navigare all'interno degli archivi tar. Questo viene fatto attraverso gli URL annidati. Per esempio, un file in un archivio tar su un server http potrebbe avere come URL

    http://www-com.physik.hu-berlin.de/~bernd/article.tgz#tar:/paper.tex

#### Usare KIO

I job in molti casi sono creati chiamando le funzioni contenute nel namespace KIO. Esse ricevono uno o due URL come argomenti ed eventualmente altri parametri. Quando un job è concluso, emette il segnale `result(KIO::Job*)`. Dopo che questo segnale è stato emesso, il job si cancella. Quindi un caso d'uso tipico sarà simile a questo:

    void FooClass::makeDirectory()
    {
        SimpleJob *job = KIO::mkdir(KURL("file:/home/bernd/kiodir"));
        connect( job, SIGNAL(result(KIO::Job*)),
                 this, SLOT(mkdirResult(KIO::Job*)) );
    }

    void FooClass::mkdirResult(KIO::Job *job)
    {
        if (job->error())
            job->showErrorDialog();
        else
            cout << "mkdir went fine" << endl;
    }

A seconda del tipo di job, possono essere connessi altri segnali.

Qui c'è una panoramica delle funzioni possibili:

KIO::mkdir(const KURL &url, int permission)

- Crea una directory, eventualmente con alcuni permessi.

KIO::rmdir(const KURL &url)

- Rimuove una directory

KIO::chmod(const KURL &url, int permissions)

- Cambia i permessi di un file.

KIO::rename(const KURL &src, const KURL &dest, bool overwrite)

- Rinomina un file.

KIO::symlink(const QString &target, const KURL &dest, bool overwrite, bool showProgressInfo)

- Crea un collegamento simbolico.

KIO::stat(const KURL &url, bool showProgressInfo)

- Cerca alcune informazioni sul file, come dimensione, data di modifica e permessi. L'informazione può essere ottenuta da KIO::StatJob::statResult() dopo che il job è concluso.

KIO::get(const KURL &url, bool reload, bool showProgressInfo)

- Trasferisce i dati da un URL.

KIO::put(const KURL &url, int permissions, bool overwrite, bool resume, bool showProgressInfo)

- Trasferisce i dati ad un URL

KIO::http_post(const KURL &url, const QByteArray &data, bool showProgressInfo)

- Invia dati. Comando speciale per HTTP.

KIO::mimetype(const KURL &url, bool showProgressInfo)

- Tenta di trovare il tipo MIME dell'URL. Il tipo può essere ottenuto con KIO::MimetypeJob::mimetype() al termine del job.

KIO::file_copy(const KURL &src, const KURL &dest, int permissions, bool overwrite, bool resume, bool showProgressInfo)

- Copia un singolo file.

KIO::file_move(const KURL &src, const KURL &dest, int permissions, bool overwrite, bool resume, bool showProgressInfo)

- Rinomina o muove un singolo file.

KIO::file_delete(const KURL &url, bool showProgressInfo)

- Cancella un singolo file.

KIO::listDir(const KURL &url, bool showProgressInfo)

- Elenca i contenuti di una directory. Ogni volta che vengono scoperti nuovi elementi viene emesso il segnale KIO::ListJob::entries().

KIO::listRecursive(const KURL &url, bool showProgressInfo)

- Simile alla funzione listDir(), ma questa è ricorsiva.

KIO::copy(const KURL &src, const KURL &dest, bool showProgressInfo)

- Copia un file o una directory. Queste ultime vengono copiate ricorsivamente.

KIO::move(const KURL &src, const KURL &dest, bool showProgressInfo)

- Muove o rinomina un file o una directory.

KIO::del(const KURL &src, bool shred, bool showProgressInfo)

- Cancella un file o una directory.

#### Elementi di una directory

I job di KIO::stat() e di KIO::listDir() restituiscono i loro risultati rispettivamente come tipi UDSEntry e USDEntryList. Quest'ultimo è definito come QValueList<UDSEntry>. L'acronimo UDS significa "Universal Directory Service". Il principio di base è che una voce della directory contiene le informazioni che possono essere fornite da uno slave, e nient'altro. Per esempio, lo slave http non fornisce nessuna informazione sui permessi di accesso o sui proprietari del file. Invece un UDSEntry è un elenco di UDSAtoms. Ogni atom fornisce una porzione specifica di informazione e consiste di un tipo memorizzato in m_uds e di un valore intero m_long o di una stringa m_str a seconda del tipo.

Attualmente sono definiti i seguenti tipi:

- UDS_SIZE (intero) - dimensione del file

- UDS_USER (stringa) - utente che possiede il file

- UDS_GROUP (stringa) - gruppo che possiede il file

- UDS_NAME (stringa) - nome del file

- UDS_ACCESS (intero) - permessi del file, ad es. memorizzati dalla funzione stat() di libc nel campo st_mode.

- UDS_FILE_TYPE (intero) - Il tipo di file, ad es. quello memorizzato da stat() nel campo st_mode. Quindi per controllare questo valore si possono usare le normali macro di libc. Notare che i dati forniti da ioslave corrispondono a stat() e non a lstat(), cioè nel caso dei collegamenti simbolici il tipo di file è quello del file puntato dal collegamento e non quello del collegamento stesso.

- UDS_LINK_DEST (stringa) - Nel caso di collegamenti simbolici, il nome del file puntato.

- UDS_MODIFICATION_TIME (intero) - La data (come nel tipo time_t) di quando il file è stato modificato per l'ultima volta, come ad es. memorizzato da stat() nel campo st_mtime.

- UDS_ACCESS_TIME (intero) - La data di quando si è avuto l'ultimo accesso al file, come ad es. memorizzato da stat() nel campo st_atime.

- UDS_CREATION_TIME (intero) - La data di quando il file è stato creato, come ad es. memorizzato da stat() nel campo st_ctime.

- UDS_URL (stringa) - fornisce l'URL di un file, se non è semplicemente la concatenazione dell'URL della directory e del nome del file.

- UDS_MIME_TYPE (stringa) - tipo MIME del file

- UDS_GUESSED_MIME_TYPE (stringa) - tipo MIME del file previsto dallo slave. La differenza con il tipo precedente consiste nel fatto che questo non dovrebbe essere considerato affidabile (perché la determinazione in maniera sicura sarebbe stata troppo dispendiosa). Per esempio, la classe KRun controlla esplicitamente il tipo MIME se non ha informazioni attendibili.

Nonostante il sistema di memorizzazione delle informazioni sui file nelle `UDSEntry` sia flessibile e pratico dal punto di vista ioslave, è difficile da usare per il programmatore dell'applicazione. Ad esempio, per trovare il tipo MIME di un file, si deve procedere con una iterazione attraverso tutti gli atom e controllare se `m_uds` è un `UDS_MIME_TYPE`. Fortunatamente c'è un API molto più semplice da usare: la classe `KFileItem`.

#### Uso sincrono

Spesso l'API asincrona di KIO è troppo complessa da usare e quindi l'implementazione asincrona non costituisce una priorità . Per esempio, in un programma che può gestire un solo documento alla volta c'è poco da fare quando un programma sta scaricando un file. Per questi semplici casi, esiste un'API molto più facile costituita da un insieme di funzioni statiche in KIO::NetAccess. Per esempio, per copiare un file si può usare

    KURL source, target;
    source = ...;
    target = ...
    KIO::NetAccess::copy(source, target);

La funzione ritornerà dopo che il processo completo di copia è terminato. Tuttavia questo metodo fornisce una finestra di avanzamento e si assicura che l'applicazione elabori gli eventi di ridisegno.

Una combinazione di funzioni di particolare interesse è la funzione `download()` associata alla funzione `removeTempFile()`. La prima scarica un file dall'URL fornito e lo memorizza in un file temporaneo con un nome univoco. Il nome è memorizzato nel secondo argomento. Se l'URL è locale il file non viene scaricato e il secondo argomento viene impostato con il nome del file locale. La funzione `removeTempFile()` cancella il file fornito come argomento se il file è il risultato del download della prima funzione. In caso contrario non fa nulla. Quindi un modo molto semplice di caricare i file indipendentemente dalla loro locazione è scritto nel frammento di codice seguente:

    KURL url;
    url = ...;
    QString tempFile;
    if (KIO::NetAccess::download(url, tempFile) {
        // load the file with the name tempFile
        KIO::NetAccess::removeTempFile(tempFile);
    }

#### Metadati

Come visto in precedenza, l'interfaccia ai job IO è piuttosto astratta e non comprende nessuno scambio di informazioni tra l'applicazione e lo slave. Per esempio, si possono fornire alcuni parametri allo slave HTTP per controllare l'uso della cache o per inviare assieme ad una richiesta un gruppo di cookie.Per questo è stato introdotto il concetto di metadati. Quando viene creato, un job può essere configurato fornendogli dei metadati. Ogni elemento dei metadati consiste di un paio chiave/valore. Per esempio, per evitare che lo slave HHTP carichi una pagina web dalla sua cache si può usare:

    void FooClass::reloadPage()
    {
        KURL url("http://www.kdevelop.org/index.html");
        KIO::TransferJob *job = KIO::get(url, true, false);
        job->addMetaData("cache", "reload");
        ...
    }

La stessa tecnica è usata nell'altra direzione, cioè per le comunicazioni dallo slave all'applicazione. Il metodo `Job::queryMetaData()` richiede il valore di una certa chiave inviata allo slave. Per lo slave HTTP, un esempio di questo tipo è dato dalla chiave `"modificata"` che contiene (rappresentata come stringa) la data dell'ultima modifica della pagina web. Un esempio su come si può usare tutto ciò è il seguente:

    void FooClass::printModifiedDate()
    {
        KURL url("http://developer.kde.org/documentation/kde2arch/index.html");
        KIO::TransferJob *job = KIO::get(url, true, false);
        connect( job, SIGNAL(result(KIO::Job*)),
                 this, SLOT(transferResult(KIO::Job*)) );
    }

    void FooClass::transferResult(KIO::Job *job)
    {
        QString mimetype;
        if (job->error())
            job->showErrorDialog();
        else {
            KIO::TransferJob *transferJob = (KIO::TransferJob*) job;
            QString modified = transferJob->queryMetaData("modified");
            cout << "Last modified: " << modified << endl;
    }

#### Pianificazione

Normalmente quando si usano le API di KIO non ci si deve occupare dei dettagli dell'esecuzione degli slave IO e della comunicazione con essi. L'uso normale consiste nell'avvio di un job con alcuni parametri e nella gestione dei segnali che emette.

Lo scenario dietro le quinte è molto più complicato. Quando si crea un job, esso viene messo in una coda. Quando l'applicazione ritorna all'event loop, KIO alloca dei processi per i job nella coda. Per il primo job avviato la situazione è banale: viene avviato un IO slave per il protocollo appropriato. Tuttavia, dopo che il job (come un download per un server HTTP) è terminato non viene immediatamente ucciso, ma viene messo in un insieme di slave inattivi e ucciso dopo un periodo di inattività (attualmente 3 minuti). Se giunge una nuova richiesta per lo stesso protocollo e host esso verrà riusato. L'ovvio vantaggio consiste, nel caso di una serie di job per lo stesso host, nel risparmio sul costo della creazione di nuovi processi e l'eventuale handshake per l'autenticazione.

Il riuso è ovviamente possibile solo quando gli slave esistenti hanno terminato il loro lavoro. Quando arriva una nuova richiesta mentre un processo slave già esistente è ancora in esecuzione deve essere avviato e usato un nuovo processo. Nell'uso delle API negli esempi sopra non ci sono limitazioni nella creazione di nuovi processi: se si avvia una serie di download consecutivi per 20 file diversi allora KIO eseguirà 20 processi slave. Questo schema nell'assegnazione degli slave ai job è detto diretto. Non è sempre lo schema più appropriato, siccome necessita di molta memoria e crea un alto carico sia sui sistemi client che server.

Quindi esiste una via diversa. Si possono pianificare i job. In questo caso solo un numero limitato di processi slave (attualmente 3) sarà creato. Se si creano ulteriori job verranno messi in una coda e saranno elaborati quando il processo slave diventa inattivo. Questo viene fatto così:

    KURL url("http://developer.kde.org/documentation/kde2arch/index.html");
    KIO::TransferJob *job = KIO::get(url, true, false);
    KIO::Scheduler::scheduleJob(job);

Una terza possibilità è quella orientata alla connessione. Per esempio, per lo slave IMAP non ha senso avviare processi multipli per lo stesso server. Dovrebbe essere rinforzata solo una connessione IMAP alla volta. In questo caso l'applicazione deve occuparsi direttamente con la nozione di slave. Deve deallocare uno slave per alcune connessioni e in seguito assegnare tutti i job che dovrebbero utilizzare la stessa connessione allo stesso slave. Questo può essere fatto semplicemente usando KIO::Scheduler:

    KURL baseUrl("imap://bernd@albert.physik.hu-berlin.de");
    KIO::Slave *slave = KIO::Scheduler::getConnectedSlave(baseUrl);

    KIO::TransferJob *job1 = KIO::get(KURL(baseUrl, "/INBOX;UID=79374"));
    KIO::Scheduler::assignJobToSlave(slave, job1);

    KIO::TransferJob *job2 = KIO::get(KURL(baseUrl, "/INBOX;UID=86793"));
    KIO::Scheduler::assignJobToSlave(slave, job2);

    ...

    KIO::Scheduler::disconnectSlave(slave);

Si può disconnettere lo slave dopo che sono terminati tutti i job assegnati ad esso.

#### Definire un ioslave

Di seguito si discuterà come si può aggiungere un nuovo ioslave al sistema. In analogia con i servizi, i nuovi ioslave possono essere resi noti al sistema installando un piccolo file di configurazione. Il seguente frammento di Makefile.am mostra come installare il protocollo ftp:

    protocoldir = $(kde_servicesdir)
    protocol_DATA = ftp.protocol
    EXTRA_DIST = $(mime_DATA)

Il contenuto del file ftp.protocol è:

    [Protocol]
    exec=kio_ftp
    protocol=ftp
    input=none
    output=filesystem
    listing=Name,Type,Size,Date,Access,Owner,Group,Link,
    reading=true
    writing=true
    makedir=true
    deleting=true
    Icon=ftp

La voce `"protocol"` definisce il protocollo di cui è responsabile lo slave. `"exec"` è (al contrario di quello che ci si potrebbe aspettare) il nome della libreria che implementa lo slave. Quando lo slave dove essere attivato, viene avviato l'eseguibile `"kdeinit"` che a sua volta carica la libreria nello spazio degli indirizzi. In questo modo, praticamente si può pensare ad uno slave in esecuzione come ad un processo separato anche se è implementato come libreria. Il vantaggio di un tale meccanismo consiste nel risparmio di molta memoria e la riduzione del tempo necessario al linker.

Le linee "input" e "output" non sono attualmente usate.

Le restanti linee del file `.protocol` definiscono le capacità possedute dallo slave. Generalmente, le caratteristiche che devono essere implementate da uno slave sono molto più semplici di quelle che le API di KIO devono fornire all'applicazione. Infatti i compiti più complessi sono pianificati per coppie di sotto-job. Ad esempio, per elencare una directory in modo ricorsivo, sarà eseguito un job per la directory superiore. Poi per ogni sottodirectory incontrata verranno eseguiti nuovi job. Uno scheduler di KIO si assicura che non vengano eseguiti troppi job contemporaneamente. Similmente, per copiare un file all'interno di un protocollo che non supporta la copia diretta (come il protocollo `ftp:`), KIO legge il file sorgente e scrive i dati nel file di destinazione. Per far funzionare il tutto è necessario che il file `.protocol` segnali le azioni supportate dallo slave.

Siccome gli slave sono caricati come librerie condivise ma sono costituiti da programmi standalone, il loro codice è leggermente diverso dai normali plugin fatti con le librerie statiche. La funzione che viene chiamata per avviare lo slave è chiamata `kdemain()`. Questa funzione compie alcune inizializzazioni ed in seguito entra in un event loop e attende le richieste dall'applicazione che lo usa. Appare simile a questa

    extern "C" { int kdemain(int argc, char **argv); }

    int kdemain(int argc, char **argv)
    {
        KLocale::setMainCatalogue("kdelibs");
        KInstance instance("kio_ftp");
        (void) KGlobal::locale();

        if (argc != 4) {
            fprintf(stderr, "Usage: kio_ftp protocol "
                            "domain-socket1 domain-socket2\n");
            exit(-1);
        }

        FtpSlave slave(argv[2], argv[3]);
        slave.dispatchLoop();
        return 0;
    }

#### Implementare un ioslave

Gli slave sono implementati come sottoclassi di `KIO::SlaveBase` (nell'esempio sopra FtpSlave). Quindi le azioni elencate nel file `.protocol` corrispondono ad alcune funzioni virtuali di `KIO::SlaveBase` che devono essere reimplementate dall'implementazione dello slave. Ecco una lista di azioni possibili e le funzioni virtuali corrispondenti:

reading - legge dati da un URL

- void get(const KURL &url)

writing - scrive dati in un URL e crea il file se non esiste.

- void put(const KURL &url, int permissions, bool overwrite, bool resume)

moving - rinomina un file

- void rename(const KURL &src, const KURL &dest, bool overwrite)

deleting - cancella un file o una directory.

- void del(const KURL &url, bool isFile)

listing - Elenca i contenuti di una directory.

- void listDir(const KURL &url)

makedir - Crea una directory.

- void mkdir(const KURL &url, int permissions)

In aggiunta a queste ci sono delle funzioni reimplementabili che non sono elencate nel file `.protocol`. KIO determina se queste operazioni sono supportate o no (cioè se l'implementazione predefinita restituisce un errore).

Fornisce informazioni su un file, come la funzione C stat().

- void stat(const KURL &url)

Cambia i permessi di accesso di un file

- void chmod(const KURL &url, int permissions)

Determina il tipo MIME di un file.

- void mimetype(const KURL &url)

Copia un file.

- copy(const KURL &url, const KURL &dest, int permissions, bool overwrite)

Crea un collegamento simbolico.

- void symlink(const QString &target, const KURL &dest, bool overwrite)

Tutte queste implementazioni dovrebbero terminare con una di queste due chiamate: se l'operazione ha avuto successo, dovrebbero chiamare la funzione `finished()`. Se accade un errore, dovrebbe essere chiamata la funzione `error()` con un codice di errore come primo argomento e una stringa come secondo. I codici di errore possibili sono elencati come enumerazioni di `KIO::Error`. Il secondo argomento è normalmente l'URL in questione. È usato ad esempio nella funzione `KIO::Job::showErrorDialog()` per parametrizzare il messaggio di errore in forma leggibile.

Per gli slave corrispondenti ai protocolli di rete potrebbe essere interessante reimplementare il metodo `SlaveBase::setHost()`. Questo viene chiamato per indicare al processo slave l'host, la porta e il nome utente e la password per effettuare il login. Generalmente, i metadati impostati dall'applicazione possono essere richiesti dalla funzione `SlaveBase::metaData()`. Si può controllare l'esistenza di metadati relativi ad una data chiave con la funzione `SlaveBase::hasMetaData()`.

#### Comunicare all'applicazione

Diverse azioni implementate nello slave necessitano di sistemi per comunicare i dati all'applicazione usando il processo slave:

- La funzione `get()` invia blocchi di dati. L'invio viene effettuato con la funzione `data()`, che riceve come argomento un `QByteArray`. Certamente non è necessario inviare tutti i dati insieme. Se si invia un file grande chiamare la funzione `data()` con piccoli blocchi di dati in modo che l'applicazione li possa elaborare. Chiamare `finished()` al termine del trasferimento.

- La funzione `listDir()` riporta le informazioni sugli elementi di una directory. Per questo scopo chiama `listEntries()` con un argomento di tipo `KIO::UDSEntryList`. Analogamente alla funzione `data()` può essere chiamata diverse volte. Quando termina, chiamare `listEntry()` con il secondo argomento impostato su true. Si può anche chiamare `totalSize()` per sapere il numero totale degli elementi della directory, se è noto.

- `stat()` riferisce le informazioni su un file come la dimensione, il tipo MIME, ecc. Tali informazioni sono impacchettate in un `KIO::UDSEntry` che sarà dicusso più avanti. Usare `statEntry()` per inviare un tale oggetto all'applicazione.

- `mimetype()` chiama la funzione `mimetype()` con un argomento di tipo stringa.

- Le funzioni `get()` e `copy()` potrebbero fornire informazioni sull'avanzamento. Questo viene fatto con i metodi `totalSize()`, `processedSize()` e `speed()`. La dimensione totale e la dimensione elaborata sono misurate in byte e la velocità in byte al secondo.

- Si possono inviare coppie di metadati di tipo chiave/valore con la funzione `setMetaData()`.

#### Interagire con l'utente

A volte uno slave deve interagire con l'utente. Alcuni esempi comprendono i messaggi di informazione, le finestre di dialogo per l'autenticazione e le finestre di conferma quando un file sta per essere sovrascritto.

- `infoMessage()` - usato per avere un feedback, come ad esempio per un messaggio del tipo "Scaricamento dati dall'<host>" dallo slave http, che viene visualizzato spesso nella barra di stato dei programmi. Dalla parte dell'applicazione questo metodo corrisponde al segnale `KIO::Job::infoMessage()`.

- `warning()` - Visualizza un avvertimento in una finestra con `KMessageBox::information()`. Se una finestra rimane aperta da una precedente chiamata di warning() dallo stesso processo slave non succede nulla.

- `messageBox()` - questo è un metodo più completo del metodo precedente. Permette di aprire una finestra con il testo, il titolo e alcuni pulsanti. Vedere come riferimento l'enumerazione `SlaveBase::MessageBoxType`.

- `openPassDlg()` - apre una finestra di dialogo per l'inserimento del nome utente e password.

## Licenza

&underFDL; &underGPL;