debug::caller - debug narrative

[ Tcllib Home | Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]

# debug::caller(n) 1.1 tcllib "debug narrative"

## Name

debug::caller - debug narrative - caller

## Synopsis

- package require Tcl 8.5
- package require debug::caller ?1.1?

- debug caller ?args...?

## Description

## API

debug caller ?args...?

  This method is useful in a tag-specific prefix to automatically provide caller information for all uses of the tag. Or in a message, when only specific places need such detail.

  Beyond that it recognizing the various internal forms of method calls generated by the snit OO system and rewrites these to their original form, for better readability. Similarly for TclOO.

  If args are specified then they are treated as the integer indices of command arguments to not show in the output. The referenced arguments are replaced by * instead. The main anticipiated use case for this is the exclusion of arguments expected to contain large Tcl values, i.e. long lists, large dictionaries, etc. to prevent them from overwhelming the narrative.

## Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category debug of the Tcllib Trackers. Please also report any ideas for enhancements you may have for either package and/or documentation.

When proposing code changes, please provide unified diffs, i.e the output of diff -u.

Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar.

## Keywords

debug, log, narrative, trace

## Category

debugging, tracing, and logging

## Copyright

Copyright © 2012-2015, Andreas Kupries <andreas_kupries@users.sourceforge.net>