VirtualBox

Ignore:
Timestamp:
Oct 27, 2010 12:15:28 PM (14 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
67088
Message:

iprt/string.h: Moved the string format docs to the header so it is easier to find.

Location:
trunk/src/VBox/Runtime/common/string
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/Runtime/common/string/strformat.cpp

    r29783 r33496  
    485485#ifndef IN_RING3
    486486                    case 'S':   /* Unicode string as current code page -> Unicode as UTF-8 in GC/R0. */
    487                         chArgSize = 'l';
     487                        chArgSize = 'l'; /** @todo this is nonsensical, isn't it? */
    488488                        /* fall thru */
    489489#endif

  • trunk/src/VBox/Runtime/common/string/strformatrt.cpp

    r33299 r33496  
    55
    66/*
    7  * Copyright (C) 2006-2007 Oracle Corporation
     7 * Copyright (C) 2006-2010 Oracle Corporation
    88 *
    99 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    2525 */
    2626
    27 /** @page pg_rt_str_format_rt   The IPRT String Format Extensions
    28  *
    29  * The string formatter supports most of the non-float format types and flags.
    30  * See RTStrFormatV() for the full tail there. In addition we've added a number
    31  * of iprt specific format types for the iprt typedefs and other useful stuff.
    32  * Note that several of these are similar to \%p and doesn't care much if you try
    33  * add formating flags/width/precision.
    34  *
    35  *
    36  * Group 1, the basic runtime typedefs (excluding those which obviously are pointer).
    37  *      - \%RTbool          - Takes a bool value and prints 'true', 'false', or '!%d!'.
    38  *      - \%RTfile          - Takes a #RTFILE value.
    39  *      - \%RTfmode         - Takes a #RTFMODE value.
    40  *      - \%RTfoff          - Takes a #RTFOFF value.
    41  *      - \%RTfp16          - Takes a #RTFAR16 value.
    42  *      - \%RTfp32          - Takes a #RTFAR32 value.
    43  *      - \%RTfp64          - Takes a #RTFAR64 value.
    44  *      - \%RTgid           - Takes a #RTGID value.
    45  *      - \%RTino           - Takes a #RTINODE value.
    46  *      - \%RTint           - Takes a #RTINT value.
    47  *      - \%RTiop           - Takes a #RTIOPORT value.
    48  *      - \%RTldrm          - Takes a #RTLDRMOD value.
    49  *      - \%RTmac           - Takes a #PCRTMAC pointer.
    50  *      - \%RTnaddr         - Takes a #PCRTNETADDR value.
    51  *      - \%RTnaipv4        - Takes a #RTNETADDRIPV4 value.
    52  *      - \%RTnaipv6        - Takes a #PCRTNETADDRIPV6 value.
    53  *      - \%RTnthrd         - Takes a #RTNATIVETHREAD value.
    54  *      - \%RTnthrd         - Takes a #RTNATIVETHREAD value.
    55  *      - \%RTproc          - Takes a #RTPROCESS value.
    56  *      - \%RTptr           - Takes a #RTINTPTR or #RTUINTPTR value (but not void *).
    57  *      - \%RTreg           - Takes a #RTCCUINTREG value.
    58  *      - \%RTsel           - Takes a #RTSEL value.
    59  *      - \%RTsem           - Takes a #RTSEMEVENT, #RTSEMEVENTMULTI, #RTSEMMUTEX, #RTSEMFASTMUTEX, or #RTSEMRW value.
    60  *      - \%RTsock          - Takes a #RTSOCKET value.
    61  *      - \%RTthrd          - Takes a #RTTHREAD value.
    62  *      - \%RTuid           - Takes a #RTUID value.
    63  *      - \%RTuint          - Takes a #RTUINT value.
    64  *      - \%RTunicp         - Takes a #RTUNICP value.
    65  *      - \%RTutf16         - Takes a #RTUTF16 value.
    66  *      - \%RTuuid          - Takes a #PCRTUUID and will print the UUID as a string.
    67  *      - \%RTxuint         - Takes a #RTUINT or #RTINT value, formatting it as hex.
    68  *      - \%RGi             - Takes a #RTGCINT value.
    69  *      - \%RGp             - Takes a #RTGCPHYS value.
    70  *      - \%RGr             - Takes a #RTGCUINTREG value.
    71  *      - \%RGu             - Takes a #RTGCUINT value.
    72  *      - \%RGv             - Takes a #RTGCPTR, #RTGCINTPTR or #RTGCUINTPTR value.
    73  *      - \%RGx             - Takes a #RTGCUINT or #RTGCINT value, formatting it as hex.
    74  *      - \%RHi             - Takes a #RTHCINT value.
    75  *      - \%RHp             - Takes a #RTHCPHYS value.
    76  *      - \%RHr             - Takes a #RTHCUINTREG value.
    77  *      - \%RHu             - Takes a #RTHCUINT value.
    78  *      - \%RHv             - Takes a #RTHCPTR, #RTHCINTPTR or #RTHCUINTPTR value.
    79  *      - \%RHx             - Takes a #RTHCUINT or #RTHCINT value, formatting it as hex.
    80  *      - \%RRv             - Takes a #RTRCPTR, #RTRCINTPTR or #RTRCUINTPTR value.
    81  *      - \%RCi             - Takes a #RTINT value.
    82  *      - \%RCp             - Takes a #RTCCPHYS value.
    83  *      - \%RCr             - Takes a #RTCCUINTREG value.
    84  *      - \%RCu             - Takes a #RTUINT value.
    85  *      - \%RCv             - Takes a #uintptr_t, #intptr_t, void * value.
    86  *      - \%RCx             - Takes a #RTUINT or #RTINT value, formatting it as hex.
    87  *
    88  *
    89  * Group 2, the generic integer types which are prefered over relying on what
    90  * bit-count a 'long', 'short',  or 'long long' has on a platform. This are
    91  * highly prefered for the [u]intXX_t kind of types.
    92  *      - \%RI[8|16|32|64]  - Signed integer value of the specifed bit count.
    93  *      - \%RU[8|16|32|64]  - Unsigned integer value of the specifed bit count.
    94  *      - \%RX[8|16|32|64]  - Hexadecimal integer value of the specifed bit count.
    95  *
    96  *
    97  * Group 3, hex dumpers and other complex stuff which requires more than simple formatting.
    98  *      - \%Rhxd            - Takes a pointer to the memory which is to be dumped in typical
    99  *                            hex format. Use the precision to specify the length, and the width to
    100  *                            set the number of bytes per line. Default width and precision is 16.
    101  *      - \%Rhxs            - Takes a pointer to the memory to be displayed as a hex string,
    102  *                            i.e. a series of space separated bytes formatted as two digit hex value.
    103  *                            Use the precision to specify the length. Default length is 16 bytes.
    104  *                            The width, if specified, is ignored.
    105  *      - \%Rrc             - Takes an integer iprt status code as argument. Will insert the
    106  *                            status code define corresponding to the iprt status code.
    107  *      - \%Rrs             - Takes an integer iprt status code as argument. Will insert the
    108  *                            short description of the specified status code.
    109  *      - \%Rrf             - Takes an integer iprt status code as argument. Will insert the
    110  *                            full description of the specified status code.
    111  *      - \%Rra             - Takes an integer iprt status code as argument. Will insert the
    112  *                            status code define + full description.
    113  *      - \%Rwc             - Takes a long Windows error code as argument. Will insert the status
    114  *                            code define corresponding to the Windows error code.
    115  *      - \%Rwf             - Takes a long Windows error code as argument. Will insert the
    116  *                            full description of the specified status code.
    117  *      - \%Rwa             - Takes a long Windows error code as argument. Will insert the
    118  *                            error code define + full description.
    119  *
    120  *      - \%Rhrc            - Takes a COM/XPCOM status code as argument. Will insert the status
    121  *                            code define corresponding to the Windows error code.
    122  *      - \%Rhrf            - Takes a COM/XPCOM status code as argument. Will insert the
    123  *                            full description of the specified status code.
    124  *      - \%Rhra            - Takes a COM/XPCOM error code as argument. Will insert the
    125  *                            error code define + full description.
    126  *
    127  *      - \%Rfn             - Pretty printing of a function or method. It drops the
    128  *                            return code and parameter list.
    129  *      - \%Rbn             - Prints the base name.  For dropping the path in
    130  *                            order to save space when printing a path name.
    131  *
    132  * On other platforms, \%Rw? simply prints the argument in a form of 0xXXXXXXXX.
    133  *
    134  *
    135  * Group 4, structure dumpers.
    136  *
    137  *      - \%RDtimespec      - Takes a PCRTTIMESPEC.
    138  *
    139  *
    140  * Group 5, XML / HTML escapers.
    141  *      - \%RMas            - Takes a string pointer (const char *) and outputs
    142  *                            it as an attribute value with the proper escaping.
    143  *                            This typically ends up in double quotes.
    144  *
    145  *      - \%RMes            - Takes a string pointer (const char *) and outputs
    146  *                            it as an element with the necessary escaping.
    147  *
    148  *
    149  */
    15027
    15128/*******************************************************************************
    … …  
    17451/**
    17552 * Callback to format iprt formatting extentions.
    176  * See @ref pg_rt_str_format_rt for a reference on the format types.
     53 * See @ref pg_rt_str_format for a reference on the format types.
    17754 *
    17855 * @returns The number of bytes formatted.
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette