src/other/prune_trie.h

   1 /* -*- mode: C++; c-basic-offset: 4; tab-width: 4 -*-
   2  *
   3  * Copyright (c) 2008 Apple Inc. All rights reserved.
   4  *
   5  * @APPLE_LICENSE_HEADER_START@
   6  *
   7  * This file contains Original Code and/or Modifications of Original Code
   8  * as defined in and that are subject to the Apple Public Source License
   9  * Version 2.0 (the 'License'). You may not use this file except in
  10  * compliance with the License. Please obtain a copy of the License at
  11  * http://www.opensource.apple.com/apsl/ and read it before using this
  12  * file.
  13  *
  14  * The Original Code and all software distributed under the License are
  15  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  16  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  17  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  19  * Please see the License for the specific language governing rights and
  20  * limitations under the License.
  21  *
  22  * @APPLE_LICENSE_HEADER_END@
  23  */
  24
  25 #include <stdint.h>
  26
  27
  28 #if __cplusplus
  29 extern "C" {
  30 #endif /* __cplusplus */
  31
  32
  33 /*
  34  * prune_trie() is a C vended function that is used by strip(1) to prune out
  35  * defined exported symbols from the export trie.  It is passed a pointer to
  36  * the start of bytes of the the trie and the size.  The prune() funciton
  37  * passed is called with each symbol name in the trie to determine if it is
  38  * to be pruned (retuning 1) or not (returning 0).  It writes the new trie
  39  * back into the trie buffer and returns the new size in trie_new_size.
  40  * If the pruning succeeds, NULL is returned.  If there was an error processing
  41  * the trie (e.f. it is malformed), then an error message string is returned.
  42  * The error string can be freed.
  43  */
  44 extern const char*
  45 prune_trie(
  46         uint8_t*        trie_start,
  47         uint32_t        trie_start_size,
  48         int                     (*prune)(const char *name),
  49         uint32_t*       trie_new_size);
  50
  51
  52 #if __cplusplus
  53 }
  54 #endif /* __cplusplus */