<HTML> <HEAD> <TITLE>Source: ksycocadict.h</TITLE> <META NAME="Generator" CONTENT="KDOC "> </HEAD> <BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff"> <TABLE WIDTH="100%" BORDER="0"> <TR> <TD> <TABLE BORDER="0"> <TR><TD valign="top" align="left" cellspacing="10"> <h1>Source: ksycocadict.h</h1> </TD> <TD valign="top" align="right" colspan="1"></TD></TR> </TABLE> <HR> <TABLE BORDER="0"> </TABLE> </TD> <TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR> <TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR> <TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR> <TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR> <TR><TD><small><A HREF="index.html">Index</A></small></TD></TR> </TABLE></TD></TR></TABLE> <pre> /* This file is part of the KDE libraries * Copyright (C) 1999 Waldo Bastian <bastian@kde.org> * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public * License version 2 as published by the Free Software Foundation; * * This library 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 * Library General Public License for more details. * * You should have received a copy of the GNU Library General Public License * along with this library; see the file COPYING.LIB. If not, write to * the Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. **/ #ifndef __ksycocadict_h__ #define __ksycocadict_h__ "$Id: ksycocadict.h,v 1.1 1999/10/20 22:54:05 dfaure Exp $" #include <qstring.h> #include <qvaluelist.h> #include <qdatastream.h> class KSycocaEntry; class KSycocaDictStringList; /** * @internal * Hash table implementation for the sycoca database file */ class KSycocaDict { public: /** * Create an empty dict, for building the database */ KSycocaDict(); /** * Create a dict from an existing database */ KSycocaDict(QDataStream *str, int offset); ~KSycocaDict(); /** * Adds a 'payload' to the dictionary with key 'key'. * * 'payload' should have a valid offset by the time * the dictionary gets saved. **/ void add(const QString &key, KSycocaEntry *payload); /** * Looks up an entry identified by 'key'. * * If 0 is returned, no matching entry exists. * Otherwise, the offset of the entry is returned. * * NOTE: It is not guaranteed that this entry is * indeed the one you were looking for. * After loading the entry you should check that it * indeed matches the search key. If it doesn't * then no matching entry exists. */ int find_string(const QString &key ); /** * The number of entries in the dictionary. * * Only valid when building the database. */ uint count(); /** * Reset the dictionary. * * Only valid when building the database. */ void clear(); /** * Save the dictionary to the stream * A reasonable fast hash algorithm will be created. * * Typically this will find 90% of the entries directly. * Average hash table size: nrOfItems * 20 bytes. * Average duplicate list size: nrOfItms * avgKeyLength / 5. * * Unknown keys have an average 20% chance to give a false hit. * (That's why your program should check the result) * * Example: * Assume 1000 items with an average key length of 60 bytes. * * Approx. 900 items will hash directly to the right entry. * Approx. 100 items require a lookup in the duplicate list. * * The hash table size will be approx. 20Kb. * The duplicate list size will be approx. 12Kb. **/ void save(QDataStream &str); protected: Q_UINT32 hashKey( const QString &); private: KSycocaDictStringList *d; QDataStream *mStr; Q_INT32 mOffset; Q_UINT32 mHashTableSize; QValueList<Q_INT32> mHashList; }; #endif </pre> <HR> <table> <tr><td><small>Generated by: qateam on updates.mandrakesoft.com on Mon Dec 30 16:08:56 2002, using kdoc 2.0a53.</small></td></tr> </table> </BODY> </HTML>