/*! Sunrise Data Dictionary Library * * @brief a library for hashtable storage of arbitrary data objects * with built-in reference counting and guaranteed order iteration. * * @file dd_defaults.h * defaults used by the library * * @author Benjamin Kowarsch * * @note The author's true email address is herewith specifically excluded * from the license of this software. You are _not permitted_ to make the * author's true email address available to any third party. You may only * pass on the modified version of the email address as presented above. * * (C) 2006 Sunrise Telephone Systems Ltd. All rights reserved. * * @cond LICENSE_TERMS * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * Under no circumstances is it permitted for any licensee to take credit for * the creation of the Software, to claim authorship or ownership in the * Software or in any other way give the impression that they have created * the Software. Credit to the true authors and copyright holders of the * Software is absolutely mandatory and must be given as follows: * * Software packages incorporating the Software or substantial portions of it * shall display a copyright notice for the Software in the same manner as * they display any other copyright notice; shall display an authorship * notice for the Software in the same manner as they display any other * authorship notice; and shall display the license terms or a reference to * the license terms of the Software in the same manner as they display any * other license or license reference. * * GUI-based or GUI-alike interactive installers installing the Software or * substantial portions of it, shall display the Software's copyright notice, * authorship notice and license terms in full during the installation * process. Other installers such as shell command driven package installers * on Unix systems shall display copyright, authorship and license in the * same manner as for any other software. Installers shall allow users to * install the license file for the Software along with the Software itself. * * Software which makes use of but does not incorporate, nor bundle, nor * install the Software or substantial portions of it, is NOT required to * display any copyright, authorship, license terms or license reference for * the Software. Static linking to the Software constitutes 'incorporating', * dynamic linking to the Software constitutes 'making use of' the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER * DEALINGS IN THE SOFTWARE. * * In countries and territories where the above no-warranty disclaimer is * not permissible by applicable law, the following terms apply: * * NO PERMISSION TO USE THE SOFTWARE IS GRANTED AND THE SOFTWARE MUST NOT BE * USED AT ALL IN SUCH COUNTRIES AND TERRITORIES WHERE THE ABOVE NO-WARRANTY * DISCLAIMER IS NOT PERMISSIBLE AND INVALIDATED BY APPLICABLE LAW. HOWEVER, * THE COPYRIGHT HOLDERS HEREBY WAIVE THEIR RIGHT TO PURSUE OFFENDERS AS LONG * AS THEY OTHERWISE ABIDE BY THE TERMS OF THE LICENSE AS APPLICABLE FOR USE * OF THE SOFTWARE IN COUNTRIES AND TERRITORIES WHERE THE ABOVE NO-WARRANTY * DISCLAIMER IS PERMITTED BY APPLICABLE LAW. THIS WAIVER DOES NOT CONSTITUTE * A LICENSE TO USE THE SOFTWARE IN COUNTRIES AND TERRITORIES WHERE THE ABOVE * NO-WARRANTY DISCLAIMER IS NOT PERMISSIBLE AND INVALIDATED BY APPLICABLE * LAW. ANY LIABILITY OF ANY KIND IS CATEGORICALLY RULED OUT AT ALL TIMES. * * @endcond */ #ifndef _DD_LIB_INFO_H #define _DD_LIB_INFO_H #include "dd_types.h" #include "dd_macros.h" // -------------------------------------------------------------------------- // function: dd_library_version() // -------------------------------------------------------------------------- // // Returns the library version number. inline cardinal dd_library_version() DD_ALWAYS_INLINE; // -------------------------------------------------------------------------- // function: dd_significant_chars() // -------------------------------------------------------------------------- // // Returns the number of significant characters used to calculate hash values // when using one of the library supplied hash functions. The factory default // for this value is 32. inline cardinal dd_significant_chars() DD_ALWAYS_INLINE; // -------------------------------------------------------------------------- // function: dd_default_hash_is_case_sensitive() // -------------------------------------------------------------------------- // // Returns true if the default hash function is case sensitive, returns false // otherwise. The factory default for this value is 'true'. inline bool dd_default_hash_is_case_sensitive() DD_ALWAYS_INLINE; // -------------------------------------------------------------------------- // function: dd_default_hash_function() // -------------------------------------------------------------------------- // // Returns a pointer to the default hash function used when no specific hash // function has been set. The factory default is dd_SDBM_hash_string(). inline dd_hash_function dd_default_hash_function() DD_ALWAYS_INLINE; // -------------------------------------------------------------------------- // function: dd_keys_are_automatically_trimmed() // -------------------------------------------------------------------------- // // Returns true if leading and trailing whitespace is automatically removed // from keys and symbols when they are added to a dictionary or symbol table, // returns false otherwise. The factory default for this value is 'true'. inline bool dd_keys_are_automatically_trimmed() DD_ALWAYS_INLINE; // -------------------------------------------------------------------------- // function: dd_printable_7bit_ASCII_only() // -------------------------------------------------------------------------- // // Returns true if keys and symbols containing any characters _other_ than // printable 7bit ASCII characters are rejected, returns false otherwise. // The factory default for this value is 'false'. inline bool dd_printable_7bit_ASCII_keys_only() DD_ALWAYS_INLINE; // -------------------------------------------------------------------------- // function: dd_maximum_key_length() // -------------------------------------------------------------------------- // // Returns the maximum length for keys stored in dictionaries. The factory // default for this value is 128. inline cardinal dd_maximum_key_length() DD_ALWAYS_INLINE; // -------------------------------------------------------------------------- // function: dd_default_hashtable_size() // -------------------------------------------------------------------------- // // Returns the default hashtable size for creating dictionaries. The factory // default for this value is 257. inline cardinal dd_default_hashtable_size() DD_ALWAYS_INLINE; // -------------------------------------------------------------------------- // function: dd_default_symtable_size() // -------------------------------------------------------------------------- // // Returns the default hashtable size for creating symbol tables. The factory // default for this value is 257. inline cardinal dd_default_symtable_size() DD_ALWAYS_INLINE; #endif // END OF FILE