Changeset 238 for trunk


Ignore:
Timestamp:
04/29/11 16:36:13 (14 years ago)
Author:
tim
Message:

moved development documentation back to old location, adjusted build scripts accordingly

misc documentation fixes

Location:
trunk
Files:
2 edited
7 moved

Legend:

Unmodified
Added
Removed

  • trunk/SConstruct

    r234 r238  
    6767               "python3 pyregfi-distutils.py install | tee pyregfi3-install.log")
    6868
     69# API documentation
     70regfi_doc = env.Command('doc/devel/regfi/index.html',
     71                        Glob('lib/*.c')+Glob('include/*.h')+['doc/devel/Doxyfile.regfi'],
     72                        'doxygen doc/devel/Doxyfile.regfi')
     73pyregfi_doc = env.Command('doc/devel/pyregfi/index.html',
     74                          Glob('python/pyregfi/*.py')+['doc/devel/Doxyfile.pyregfi', regfi_doc],
     75                          'doxygen doc/devel/Doxyfile.pyregfi')
     76
    6977
    7078# User Friendly Targets
    … …  
    7482env.Alias('bin', [reglookup_recover, reglookup])
    7583env.Alias('doc', [man_reglookup,man_reglookup_recover,man_reglookup_timeline])
     84env.Alias('doc-devel', [regfi_doc, pyregfi_doc])
    7685env.Alias('install', install_items)
    7786

  • trunk/doc/devel/Doxyfile.pyregfi

    r236 r238  
    3939# where doxygen was started. If left blank the current directory will be used.
    4040
    41 OUTPUT_DIRECTORY       = doc/pyregfi
     41OUTPUT_DIRECTORY       = doc/devel/pyregfi
    4242
    4343# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
    … …  
    582582# with spaces.
    583583
    584 INPUT                  = trunk/python/pyregfi
     584INPUT                  = python/pyregfi
    585585
    586586# This tag can be used to specify the character encoding of the source files
    … …  
    13521352# is run, you must also specify the path to the tagfile here.
    13531353
    1354 TAGFILES               = doc/regfi/regfi.tags=../regfi
     1354TAGFILES               = doc/devel/regfi/regfi.tags=../regfi
    13551355
    13561356# When a file name is specified after GENERATE_TAGFILE, doxygen will create

  • trunk/doc/devel/Doxyfile.regfi

    r236 r238  
    3939# where doxygen was started. If left blank the current directory will be used.
    4040
    41 OUTPUT_DIRECTORY       = doc/regfi
     41OUTPUT_DIRECTORY       = doc/devel/regfi
    4242
    4343# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
    … …  
    582582# with spaces.
    583583
    584 INPUT                  = trunk/lib trunk/include trunk/python/pyregfi
     584INPUT                  = lib include
    585585
    586586# This tag can be used to specify the character encoding of the source files
    … …  
    12811281
    12821282MACRO_EXPANSION        = NO
    1283 
     1283 
    12841284# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
    12851285# then the macro expansion is limited to the macros specified with the
    … …  
    13571357# a tag file that is based on the input files it reads.
    13581358
    1359 GENERATE_TAGFILE       = doc/regfi/regfi.tags
     1359GENERATE_TAGFILE       = doc/devel/regfi/regfi.tags
    13601360
    13611361# If the ALLEXTERNALS tag is set to YES all external classes will be listed

  • trunk/include/regfi.h

    r233 r238  
    8585#endif
    8686#ifdef REGFI_WIN32
    87 #define _EXPORT __declspec(dllexport)
     87#define _EXPORT() __declspec(dllexport)
    8888#else
    89 #define _EXPORT __attribute__((visibility("default")))
     89#define _EXPORT() __attribute__((visibility("default")))
    9090#endif
    9191
    … …  
    729729 * registry hive as well as file header (REGF block) data.  This structure
    730730 * also stores a list of warnings and error messages generated while parsing
    731  * the registry hive.  These can be tuned using @ref regfi_set_message_mask. 
     731 * the registry hive.  These can be tuned using @ref regfi_log_set_mask. 
    732732 * Messages may be retrieved using @ref regfi_log_get_str.
    733733 *
    … …  
    880880
    881881
     882
    882883/** Returns the current regfi library version
    883884 *
    … …  
    886887 * @ingroup regfiBase
    887888 */
    888 _EXPORT
     889_EXPORT()
    889890const char* regfi_version();
    890891
    … …  
    900901 * @ingroup regfiBase
    901902 */
    902 _EXPORT
     903_EXPORT()
    903904REGFI_FILE* regfi_alloc(int fd, REGFI_ENCODING output_encoding);
    904905
    … …  
    916917 * @ingroup regfiBase
    917918 */
    918 _EXPORT
     919_EXPORT()
    919920REGFI_FILE* regfi_alloc_cb(REGFI_RAW_FILE* file_cb,
    920921                           REGFI_ENCODING output_encoding);
    … …  
    927928 * @ingroup regfiBase
    928929 */
    929 _EXPORT
     930_EXPORT()
    930931void regfi_free(REGFI_FILE* file);
    931932
    … …  
    938939 * @ingroup regfiBase
    939940 */
    940 _EXPORT
     941_EXPORT()
    941942char* regfi_log_get_str();
    942943
    … …  
    968969 * @ingroup regfiBase
    969970 */
    970 _EXPORT
     971_EXPORT()
    971972bool regfi_log_set_mask(uint16_t mask);
    972973
    … …  
    979980 * @ingroup regfiBase
    980981 */
    981 _EXPORT
     982_EXPORT()
    982983const REGFI_NK*       regfi_get_rootkey(REGFI_FILE* file);
    983984
    … …  
    998999 * @ingroup regfiBase
    9991000 */
    1000 _EXPORT
     1001_EXPORT()
    10011002void regfi_free_record(REGFI_FILE* file, const void* record);
    10021003
    … …  
    10191020 * @ingroup regfiBase
    10201021 */
    1021 _EXPORT
     1022_EXPORT()
    10221023bool regfi_reference_record(REGFI_FILE* file, const void* record);
    10231024
    … …  
    10341035 * @ingroup regfiBase
    10351036 */
    1036 _EXPORT
     1037_EXPORT()
    10371038uint32_t regfi_fetch_num_subkeys(const REGFI_NK* key);
    10381039
    … …  
    10491050 * @ingroup regfiBase
    10501051 */
    1051 _EXPORT
     1052_EXPORT()
    10521053uint32_t regfi_fetch_num_values(const REGFI_NK* key);
    10531054
    … …  
    10631064 * @ingroup regfiBase
    10641065 */
    1065 _EXPORT
     1066_EXPORT()
    10661067const REGFI_CLASSNAME* regfi_fetch_classname(REGFI_FILE* file,
    10671068                                             const REGFI_NK* key);
    … …  
    10771078 * @ingroup regfiBase
    10781079 */
    1079 _EXPORT
     1080_EXPORT()
    10801081const REGFI_SK* regfi_fetch_sk(REGFI_FILE* file, const REGFI_NK* key);
    10811082
    … …  
    10911092 * @ingroup regfiBase
    10921093 */
    1093 _EXPORT
     1094_EXPORT()
    10941095const REGFI_DATA* regfi_fetch_data(REGFI_FILE* file,
    10951096                                   const REGFI_VK* value);
    … …  
    11101111 * @ingroup regfiBase
    11111112 */
    1112 _EXPORT
     1113_EXPORT()
    11131114bool regfi_find_subkey(REGFI_FILE* file, const REGFI_NK* key,
    11141115                       const char* name, uint32_t* index);
    … …  
    11291130 * @ingroup regfiBase
    11301131 */
    1131 _EXPORT
     1132_EXPORT()
    11321133bool regfi_find_value(REGFI_FILE* file, const REGFI_NK* key,
    11331134                      const char* name, uint32_t* index);
    … …  
    11441145 * @ingroup regfiBase
    11451146 */
    1146 _EXPORT
     1147_EXPORT()
    11471148const REGFI_NK* regfi_get_subkey(REGFI_FILE* file, const REGFI_NK* key,
    11481149                                 uint32_t index);
    … …  
    11591160 * @ingroup regfiBase
    11601161 */
    1161 _EXPORT
     1162_EXPORT()
    11621163const REGFI_VK* regfi_get_value(REGFI_FILE* file, const REGFI_NK* key,
    11631164                                uint32_t index);
    … …  
    11741175 * @ingroup regfiBase
    11751176 */
    1176 _EXPORT
     1177_EXPORT()
    11771178const REGFI_NK* regfi_get_parentkey(REGFI_FILE* file, const REGFI_NK* key);
    11781179
    … …  
    12051206 * @ingroup regfiIteratorLayer
    12061207 */
    1207 _EXPORT
     1208_EXPORT()
    12081209REGFI_ITERATOR* regfi_iterator_new(REGFI_FILE* file);
    12091210
    … …  
    12171218 * @ingroup regfiIteratorLayer
    12181219 */
    1219 _EXPORT
     1220_EXPORT()
    12201221void regfi_iterator_free(REGFI_ITERATOR* i);
    12211222
    … …  
    12341235 * @ingroup regfiIteratorLayer
    12351236 */
    1236 _EXPORT
     1237_EXPORT()
    12371238bool regfi_iterator_down(REGFI_ITERATOR* i);
    12381239
    … …  
    12471248 * @ingroup regfiIteratorLayer
    12481249 */
    1249 _EXPORT
     1250_EXPORT()
    12501251bool regfi_iterator_up(REGFI_ITERATOR* i);
    12511252
    … …  
    12591260 * @ingroup regfiIteratorLayer
    12601261 */
    1261 _EXPORT
     1262_EXPORT()
    12621263bool regfi_iterator_to_root(REGFI_ITERATOR* i);
    12631264
    … …  
    12811282 * @ingroup regfiIteratorLayer
    12821283 */
    1283 _EXPORT
     1284_EXPORT()
    12841285bool regfi_iterator_walk_path(REGFI_ITERATOR* i, const char** path);
    12851286
    … …  
    12941295 * @ingroup regfiIteratorLayer
    12951296 */
    1296 _EXPORT
     1297_EXPORT()
    12971298const REGFI_NK* regfi_iterator_cur_key(REGFI_ITERATOR* i);
    12981299
    … …  
    13071308 * @ingroup regfiIteratorLayer
    13081309 */
    1309 _EXPORT
     1310_EXPORT()
    13101311bool regfi_iterator_first_subkey(REGFI_ITERATOR* i);
    13111312
    … …  
    13211322 * @ingroup regfiIteratorLayer
    13221323 */
    1323 _EXPORT
     1324_EXPORT()
    13241325const REGFI_NK* regfi_iterator_cur_subkey(REGFI_ITERATOR* i);
    13251326
    … …  
    13331334 * @ingroup regfiIteratorLayer
    13341335 */
    1335 _EXPORT
     1336_EXPORT()
    13361337bool regfi_iterator_next_subkey(REGFI_ITERATOR* i);
    13371338
    … …  
    13481349 * @ingroup regfiIteratorLayer
    13491350 */
    1350 _EXPORT
     1351_EXPORT()
    13511352bool regfi_iterator_find_subkey(REGFI_ITERATOR* i, const char* name);
    13521353
    … …  
    13611362 * @ingroup regfiIteratorLayer
    13621363 */
    1363 _EXPORT
     1364_EXPORT()
    13641365bool regfi_iterator_first_value(REGFI_ITERATOR* i);
    13651366
    … …  
    13751376 * @ingroup regfiIteratorLayer
    13761377 */
    1377 _EXPORT
     1378_EXPORT()
    13781379const REGFI_VK* regfi_iterator_cur_value(REGFI_ITERATOR* i);
    13791380
    … …  
    13871388 * @ingroup regfiIteratorLayer
    13881389 */
    1389 _EXPORT
     1390_EXPORT()
    13901391bool regfi_iterator_next_value(REGFI_ITERATOR* i);
    13911392
    … …  
    14021403 * @ingroup regfiIteratorLayer
    14031404 */
    1404 _EXPORT
     1405_EXPORT()
    14051406bool regfi_iterator_find_value(REGFI_ITERATOR* i, const char* name);
    14061407
    … …  
    14181419 * @ingroup regfiGlueLayer
    14191420 */
    1420 _EXPORT
     1421_EXPORT()
    14211422REGFI_NK* regfi_load_key(REGFI_FILE* file, uint32_t offset,
    14221423                         REGFI_ENCODING output_encoding,
    … …  
    14301431 * @ingroup regfiGlueLayer
    14311432 */
    1432 _EXPORT
     1433_EXPORT()
    14331434REGFI_VK* regfi_load_value(REGFI_FILE* file, uint32_t offset,
    14341435                               REGFI_ENCODING output_encoding,
    … …  
    14421443 * @ingroup regfiGlueLayer
    14431444 */
    1444 _EXPORT
     1445_EXPORT()
    14451446REGFI_SUBKEY_LIST* regfi_load_subkeylist(REGFI_FILE* file, uint32_t offset,
    14461447                                         uint32_t num_keys, uint32_t max_size,
    … …  
    14541455 * @ingroup regfiGlueLayer
    14551456 */
    1456 _EXPORT
     1457_EXPORT()
    14571458REGFI_VALUE_LIST* regfi_load_valuelist(REGFI_FILE* file, uint32_t offset,
    14581459                                       uint32_t num_values, uint32_t max_size,
    … …  
    14671468 * @ingroup regfiGlueLayer
    14681469 */
    1469 _EXPORT
     1470_EXPORT()
    14701471REGFI_BUFFER regfi_load_data(REGFI_FILE* file, uint32_t voffset,
    14711472                             uint32_t length, bool data_in_offset,
    … …  
    14791480 * @ingroup regfiGlueLayer
    14801481 */
    1481 _EXPORT
     1482_EXPORT()
    14821483REGFI_BUFFER regfi_load_big_data(REGFI_FILE* file, uint32_t offset,
    14831484                                 uint32_t data_length,uint32_t cell_length,
    … …  
    14931494 * @ingroup regfiGlueLayer
    14941495 */
    1495 _EXPORT
     1496_EXPORT()
    14961497bool regfi_interpret_data(REGFI_FILE* file,
    14971498                          REGFI_ENCODING string_encoding,
    … …  
    15081509 * @ingroup regfiGlueLayer
    15091510 */
    1510 _EXPORT
     1511_EXPORT()
    15111512const REGFI_SK* regfi_load_sk(REGFI_FILE* file, uint32_t offset,
    15121513                                  bool strict);
    … …  
    15211522 * @ingroup regfiGlueLayer
    15221523 */
    1523 _EXPORT
     1524_EXPORT()
    15241525const REGFI_HBIN* regfi_lookup_hbin(REGFI_FILE* file, uint32_t offset);
    15251526
    … …  
    15321533/******************************************************************************/
    15331534
    1534 _EXPORT
     1535_EXPORT()
    15351536REGFI_FILE* regfi_parse_regf(REGFI_RAW_FILE* file_cb, bool strict);
    15361537
    1537 _EXPORT
     1538_EXPORT()
    15381539REGFI_HBIN* regfi_parse_hbin(REGFI_FILE* file, uint32_t offset,
    15391540                             bool strict);
    … …  
    15521553 * @ingroup regfiParseLayer
    15531554 */
    1554 _EXPORT
     1555_EXPORT()
    15551556REGFI_NK* regfi_parse_nk(REGFI_FILE* file, uint32_t offset,
    15561557                             uint32_t max_size, bool strict);
    … …  
    15631564 * @ingroup regfiParseLayer
    15641565 */
    1565 _EXPORT
     1566_EXPORT()
    15661567REGFI_SUBKEY_LIST* regfi_parse_subkeylist(REGFI_FILE* file, uint32_t offset,
    15671568                                          uint32_t max_size, bool strict);
    … …  
    15741575 * @ingroup regfiParseLayer
    15751576 */
    1576 _EXPORT
     1577_EXPORT()
    15771578REGFI_VK* regfi_parse_vk(REGFI_FILE* file, uint32_t offset,
    15781579                             uint32_t max_size, bool strict);
    … …  
    15851586 * @ingroup regfiParseLayer
    15861587 */
    1587 _EXPORT
     1588_EXPORT()
    15881589REGFI_SK* regfi_parse_sk(REGFI_FILE* file, uint32_t offset,
    15891590                             uint32_t max_size, bool strict);
    … …  
    15991600 * @ingroup regfiParseLayer
    16001601 */
    1601 _EXPORT
     1602_EXPORT()
    16021603range_list* regfi_parse_unalloc_cells(REGFI_FILE* file);
    16031604
    … …  
    16091610 * @ingroup regfiParseLayer
    16101611 */
    1611 _EXPORT
     1612_EXPORT()
    16121613bool regfi_parse_cell(REGFI_RAW_FILE* file_cb, uint32_t offset,
    16131614                      uint8_t* hdr, uint32_t hdr_len,
    … …  
    16211622 * @ingroup regfiParseLayer
    16221623 */
    1623 _EXPORT
     1624_EXPORT()
    16241625uint8_t* regfi_parse_classname(REGFI_FILE* file, uint32_t offset,
    16251626                               uint16_t* name_length,
    … …  
    16331634 * @ingroup regfiParseLayer
    16341635 */
    1635 _EXPORT
     1636_EXPORT()
    16361637REGFI_BUFFER regfi_parse_data(REGFI_FILE* file, uint32_t offset,
    16371638                              uint32_t length, bool strict);
    … …  
    16451646 * @ingroup regfiParseLayer
    16461647 */
    1647 _EXPORT
     1648_EXPORT()
    16481649REGFI_BUFFER regfi_parse_little_data(REGFI_FILE* file, uint32_t voffset,
    16491650                                     uint32_t length, bool strict);
    … …  
    16571658ssize_t               regfi_raw_read(REGFI_RAW_FILE* self,
    16581659                                     void* buf, size_t count);
    1659 _EXPORT
     1660_EXPORT()
    16601661uint64_t              regfi_seek(REGFI_RAW_FILE* file_cb,
    16611662                                 uint64_t offset, int whence);
    1662 _EXPORT
     1663_EXPORT()
    16631664uint32_t              regfi_read(REGFI_RAW_FILE* file_cb,
    16641665                                 uint8_t* buf, uint32_t* length);
    16651666
    1666 _EXPORT
     1667_EXPORT()
    16671668const char*           regfi_type_val2str(unsigned int val);
    1668 _EXPORT
     1669_EXPORT()
    16691670int                   regfi_type_str2val(const char* str);
    16701671
    1671 _EXPORT
     1672_EXPORT()
    16721673char*                 regfi_get_sacl(WINSEC_DESC* sec_desc);
    1673 _EXPORT
     1674_EXPORT()
    16741675char*                 regfi_get_dacl(WINSEC_DESC* sec_desc);
    1675 _EXPORT
     1676_EXPORT()
    16761677char*                 regfi_get_owner(WINSEC_DESC* sec_desc);
    1677 _EXPORT
     1678_EXPORT()
    16781679char*                 regfi_get_group(WINSEC_DESC* sec_desc);
    16791680
    … …  
    16881689REGFI_NK*             regfi_copy_nk(const REGFI_NK* nk);
    16891690REGFI_VK*             regfi_copy_vk(const REGFI_VK* vk);
    1690 _EXPORT
     1691_EXPORT()
    16911692int32_t               regfi_calc_maxsize(REGFI_FILE* file, uint32_t offset);
    16921693int32_t               regfi_conv_charset(const char* input_charset,
    … …  
    16941695                                         uint8_t* input, char* output,
    16951696                                         uint32_t input_len, uint32_t output_max);
    1696 _EXPORT
     1697_EXPORT()
    16971698REGFI_DATA*           regfi_buffer_to_data(REGFI_BUFFER raw_data);
    16981699
    16991700/* XXX: move to base API and document */
    1700 _EXPORT
     1701_EXPORT()
    17011702void                  regfi_unix2nt_time(REGFI_NTTIME* nt, time_t t);
    1702 _EXPORT
     1703_EXPORT()
    17031704double                regfi_nt2unix_time(const REGFI_NTTIME* nt);
    17041705
    17051706
    1706 _EXPORT
     1707_EXPORT()
    17071708void regfi_interpret_keyname(REGFI_FILE* file, REGFI_NK* nk,
    17081709                             REGFI_ENCODING output_encoding, bool strict);
    1709 _EXPORT
     1710_EXPORT()
    17101711void regfi_interpret_valuename(REGFI_FILE* file, REGFI_VK* vk,
    17111712                               REGFI_ENCODING output_encoding, bool strict);
    17121713
    1713 _EXPORT
     1714_EXPORT()
    17141715void regfi_init();
    17151716
Note: See TracChangeset for help on using the changeset viewer.