| 1 | /* $Id: kDbgSymbol.cpp 2 2007-11-16 16:07:14Z bird $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * kDbg - The Debug Info Reader, Symbols.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (c) 2006-2007 knut st. osmundsen <bird-kStuff-spam@anduin.net>
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of kStuff.
|
|---|
| 10 | *
|
|---|
| 11 | * kStuff is free software; you can redistribute it and/or
|
|---|
| 12 | * modify it under the terms of the GNU Lesser General Public
|
|---|
| 13 | * License as published by the Free Software Foundation; either
|
|---|
| 14 | * version 2.1 of the License, or (at your option) any later version.
|
|---|
| 15 | *
|
|---|
| 16 | * In addition to the permissions in the GNU Lesser General Public
|
|---|
| 17 | * License, you are granted unlimited permission to link the compiled
|
|---|
| 18 | * version of this file into combinations with other programs, and to
|
|---|
| 19 | * distribute those combinations without any restriction coming from
|
|---|
| 20 | * the use of this file.
|
|---|
| 21 | *
|
|---|
| 22 | * kStuff is distributed in the hope that it will be useful,
|
|---|
| 23 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 24 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 25 | * Lesser General Public License for more details.
|
|---|
| 26 | *
|
|---|
| 27 | * You should have received a copy of the GNU Lesser General Public
|
|---|
| 28 | * License along with kStuff; if not, write to the Free Software
|
|---|
| 29 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|---|
| 30 | * 02110-1301, USA
|
|---|
| 31 | */
|
|---|
| 32 |
|
|---|
| 33 | /*******************************************************************************
|
|---|
| 34 | * Header Files *
|
|---|
| 35 | *******************************************************************************/
|
|---|
| 36 | #include "kDbgInternal.h"
|
|---|
| 37 | #include <k/kHlpAlloc.h>
|
|---|
| 38 |
|
|---|
| 39 |
|
|---|
| 40 | /**
|
|---|
| 41 | * Duplicates a symbol.
|
|---|
| 42 | *
|
|---|
| 43 | * To save heap space, the returned symbol will not own more heap space than
|
|---|
| 44 | * it strictly need to. So, it's not possible to append stuff to the symbol
|
|---|
| 45 | * or anything of that kind.
|
|---|
| 46 | *
|
|---|
| 47 | * @returns Pointer to the duplicate.
|
|---|
| 48 | * This must be freed using kDbgSymbolFree().
|
|---|
| 49 | * @param pSymbol The symbol to be duplicated.
|
|---|
| 50 | */
|
|---|
| 51 | KDBG_DECL(PKDBGSYMBOL) kDbgSymbolDup(PCKDBGSYMBOL pSymbol)
|
|---|
| 52 | {
|
|---|
| 53 | kDbgAssertPtrReturn(pSymbol, NULL);
|
|---|
| 54 | KSIZE cb = K_OFFSETOF(KDBGSYMBOL, szName[pSymbol->cchName + 1]);
|
|---|
| 55 | PKDBGSYMBOL pNewSymbol = (PKDBGSYMBOL)kHlpDup(pSymbol, cb);
|
|---|
| 56 | if (pNewSymbol)
|
|---|
| 57 | pNewSymbol->cbSelf = cb;
|
|---|
| 58 | return pNewSymbol;
|
|---|
| 59 | }
|
|---|
| 60 |
|
|---|
| 61 |
|
|---|
| 62 | /**
|
|---|
| 63 | * Frees a symbol obtained from the kDbg API.
|
|---|
| 64 | *
|
|---|
| 65 | * @returns 0 on success.
|
|---|
| 66 | * @returns KERR_INVALID_POINTER if pSymbol isn't a valid pointer.
|
|---|
| 67 | *
|
|---|
| 68 | * @param pSymbol The symbol to be freed. The null pointer is ignored.
|
|---|
| 69 | */
|
|---|
| 70 | KDBG_DECL(int) kDbgSymbolFree(PKDBGSYMBOL pSymbol)
|
|---|
| 71 | {
|
|---|
| 72 | if (!pSymbol)
|
|---|
| 73 | {
|
|---|
| 74 | kDbgAssertPtrReturn(pSymbol, KERR_INVALID_POINTER);
|
|---|
| 75 | pSymbol->cbSelf = 0;
|
|---|
| 76 | kHlpFree(pSymbol);
|
|---|
| 77 | }
|
|---|
| 78 | return 0;
|
|---|
| 79 | }
|
|---|
| 80 |
|
|---|
