proc-browse.tcl

returns a list of all the procedures present in server memory

Location:

/packages/acs-api-browser/www/proc-browse.tcl

Author:

Todd Nightingale

Created:

2000-7-14

CVS ID:

$Id: proc-browse.tcl,v 1.12 2024/09/11 06:15:46 gustafn Exp $

Related Files

• packages/acs-api-browser/www/proc-browse.tcl
• packages/acs-api-browser/www/proc-browse.adp

[ hide source ] | [ make this the default ]

File Contents

# acs-api-browser/www/proc-browse.tcl
ad_page_contract {
    returns a list of all the procedures present
    in server memory

    @author Todd Nightingale
    @creation-date 2000-7-14
    @cvs-id $Id: proc-browse.tcl,v 1.12 2024/09/11 06:15:46 gustafn Exp $

} {
    { type:word "Public" }
    { orderby:token "file"}
} -properties {
    title:onevalue
    context:onevalue
    dimensional_slider:onevalue
    proc_list:multirow
}

set dimensional {
    {type "Type" "Public" {
        {All "All" ""}
        {Public "Public" ""}
        {Private "Private" ""}
        {Deprecated "Deprecated" ""}}
    }
    {orderby "Sorted By" "file" {
        {file "File" ""}
        {name "Name" ""}}
    }
}

set title "$type Procedures"
set context [list "Browse Procedures"]
set dimensional_slider [ad_dimensional $dimensional]

set matches [list]
foreach proc [nsv_array names api_proc_doc] {
    array set doc_elements [nsv_get api_proc_doc $proc]

    if { $type eq "All"} {
        lappend matches [list $proc $doc_elements(script)]
    } elseif {$type eq "Deprecated" && $doc_elements(deprecated_p)} {
        lappend matches [list $proc $doc_elements(script)]
    } elseif {$type eq "Private" && $doc_elements(protection) eq "private" } {
        lappend matches [list $proc $doc_elements(script)]
    } elseif {$type eq "Public" && $doc_elements(protection) eq "public" } {
        lappend matches [list $proc $doc_elements(script)]
    }
}

if {$orderby eq "file"} {
    set matches [lsort -command ::apidoc::ad_sort_by_second_string_proc $matches]
} else {
    set matches [lsort -command ::apidoc::ad_sort_by_first_string_proc $matches]
}

multirow create proc_list file proc url

foreach sublist $matches {
    lassign $sublist proc file
    set url [api_proc_url $proc]
    multirow append proc_list $file $proc $url
}


# Local variables:
#    mode: tcl
#    tcl-indent-level: 4
#    indent-tabs-mode: nil
# End: