1##########  Apache functions  ##########
2
3#keywords:
4# MODULE  = the module name
5#           e.g. Apache2::Connection -> Apache2/Connection.{pm,xs}
6#
7# PACKAGE = the package name functions belong to, defaults to MODULE
8#           value of 'guess' indicates that package name should be
9#           guessed based on first argument found that maps to a Perl class
10#           fallsback on the prefix (ap_ -> Apache2, apr_ -> APR)
11#
12# PREFIX  = prefix to be stripped
13#           defaults to PACKAGE, converted to C name convention, e.g.
14#           APR::Base64 -> apr_base64_
15#           if the converted prefix does not match, defaults to ap_ or apr_
16
17#format of entries:
18# C function name | dispatch function name | argspec | Perl alias
19
20# dispatch function name defaults to C function name
21# if the dispatch name is just a prefix (mpxs_, MPXS_)
22# the C function name is appended to it
23# the return type can be specified before the C function name,
24# defaults to return_type in {Apache2,ModPerl}::FunctionTable
25
26# the argspec defaults to arguments in {Apache2,ModPerl}::FunctionTable
27# argument types can be specified to override those in the FunctionTable
28# default values can be specified, e.g. arg=default_value
29# argspec of '...' indicates passthru, calling the function with
30# (aTHX_ I32 items, SP **sp, SV **MARK)
31
32# the alias will be created in the current PACKAGE
33
34# function names that do not begin with /^\w/ are skipped
35# for details see: %ModPerl::MapUtil::disabled_map
36# in lib/ModPerl/MapUtil.pm
37
38MODULE=Apache2::RequestUtil
39 ap_get_status_line
40#_if_ do {                                                                  \
41          Apache2::Build->build_config                                      \
42	      ->httpd_version =~ /^(\d+)\.(\d+)\.(\d+)/                     \
43          ? ($1*1000+$2)*1000+$3                                            \
44          : die "Cannot get httpd version";                                 \
45      } > 2003000
46 ap_register_auth_provider | mpxs_ | ...
47#_end_
48
49MODULE=Apache2::RequestUtil   PACKAGE=guess
50 ap_psignature | | r, prefix
51>ap_finalize_request_protocol
52#_if_ do {                                                                  \
53          Apache2::Build->build_config                                      \
54	      ->httpd_version =~ /^(\d+)\.(\d+)\.(\d+)/                     \
55          ? ($1*1000+$2)*1000+$3                                            \
56          : die "Cannot get httpd version";                                 \
57      } < 2003000
58 ap_default_type
59#_end_
60 ap_get_server_name
61 ap_get_server_port
62!ap_content_type_tolower
63 ap_is_initial_req
64>ap_method_registry_init
65>ap_process_request_internal
66?ap_get_mime_headers
67>ap_rgetline_core
68?ap_get_request_note
69?ap_register_request_note
70~ap_set_content_type
71
72#MODULE=Apache2::RequestConfig
73~ap_document_root
74 ap_get_limit_req_body
75?ap_get_limit_xml_body
76>ap_core_translate
77
78>MODULE=Apache2::Core
79 ap_basic_http_header
80 ap_http_filter
81 ap_send_http_options
82 ap_send_http_trace
83 ap_response_code_string
84 ap_add_file_conf
85 ap_add_per_dir_conf
86 ap_add_per_url_conf
87 ap_limit_section
88 ap_setup_make_content_type
89
90>MODULE=Apache2::Listen
91 ap_set_listenbacklog
92 ap_set_listener
93 ap_set_send_buffer_size
94 ap_setup_listeners
95
96MODULE=Apache2::SubRequest   PACKAGE=Apache2::RequestRec
97?ap_sub_req_output_filter
98>ap_set_sub_req_protocol
99-ap_finalize_sub_req_protocol
100 ap_internal_redirect         | | r, new_uri
101 ap_internal_redirect_handler | | r, new_uri
102 ap_internal_fast_redirect    | | r, sub_req
103 ap_sub_req_lookup_dirent     | | r, finfo, subtype=AP_SUBREQ_NO_ARGS, next_filter=NULL | lookup_dirent
104
105subrequest_rec *:ap_sub_req_lookup_file | | \
106 r, new_file, next_filter=r->proto_output_filters | lookup_file
107
108subrequest_rec *:ap_sub_req_lookup_uri  | | \
109 r, new_uri, next_filter=r->proto_output_filters | lookup_uri
110
111subrequest_rec *:ap_sub_req_method_uri  | | \
112 r, method, new_uri, next_filter=r->proto_output_filters | lookup_method_uri
113
114PACKAGE=Apache2::SubRequest   ISA=Apache2::RequestRec
115 ap_destroy_sub_req  | | r | DESTROY
116 ap_run_sub_req      | mpxs_ | | run
117
118MODULE=Apache2::RequestIO   PACKAGE=Apache2::RequestRec
119 ap_discard_request_body
120!ap_getline
121 ap_get_client_block   | mpxs_ | r, SV *:buffer, bufsiz
122 ap_setup_client_block |       | r, read_policy=REQUEST_CHUNKED_ERROR
123 ap_should_client_block
124PREFIX=ap_r
125~ap_rwrite
126 ap_rprintf | mpxs_ | ...
127!ap_rputc
128~ap_rputs
129 ap_rvputs | mpxs_ | ... | puts
130-ap_vrprintf
131
132MODULE=Apache2::Response   PACKAGE=guess
133 ap_make_etag | | r, force_weak=0
134 ap_set_content_length | | r, length=r->finfo.csize
135 ap_set_etag
136 ap_meets_conditions
137 ap_rationalize_mtime
138 ap_update_mtime | | r, dependency_mtime=0
139 ap_send_error_response
140~ap_send_fd
141 ap_send_mmap | | r, mm, offset, length
142 ap_set_keepalive
143-ap_set_last_modified
144 ap_custom_response
145
146MODULE=Apache2::Access   PACKAGE=Apache2::RequestRec
147 ap_allow_methods | mpxs_ | ...
148 ap_allow_options
149 ap_allow_overrides
150!ap_allow_standard_methods
151 ap_get_remote_logname
152 SV *:ap_requires | mpxs_
153 ap_satisfies
154
155#MODULE=Apache2::Auth
156 mpxs_Apache2__RequestRec_auth_name | | r, name=NULL
157 mpxs_Apache2__RequestRec_auth_type | | r, type=NULL
158 ap_get_basic_auth_pw | MPXS_ | r
159 ap_note_auth_failure
160 ap_note_basic_auth_failure
161 ap_note_digest_auth_failure
162 ap_some_auth_required
163
164!MODULE=Apache2::ScriptUtil   PACKAGE=guess
165 ap_add_cgi_vars
166 ap_add_common_vars
167 ap_create_environment
168 ap_find_path_info
169-ap_scan_script_header_err
170-ap_scan_script_header_err_core
171-ap_scan_script_header_err_strs
172-ap_scan_script_header_err_brigade
173
174MODULE=Apache2::ServerUtil   PACKAGE=Apache2::ServerRec BOOT=1
175~ap_method_register
176 int:DEFINE_method_register | | server_rec *:s, const char *:methname
177~add_version_component
178 void:DEFINE_add_version_component | | server_rec *:s, const char *:component
179#_if_ do {                                                                  \
180          Apache2::Build->build_config                                      \
181	      ->httpd_version =~ /^(\d+)\.(\d+)\.(\d+)/                     \
182          ? ($1*1000+$2)*1000+$3                                            \
183          : die "Cannot get httpd version";                                 \
184      } > 2003000
185 mpxs_Apache2__ServerRec_loglevel | | server_rec *:s, loglevel=0
186#_end_
187
188MODULE=Apache2::ServerUtil   PACKAGE=Apache2::ServerUtil
189 ap_exists_config_define
190 ap_server_root_relative | | p, fname=""
191 ap_get_server_banner
192 ap_get_server_description
193 ap_get_server_version
194
195MODULE=Apache2::ServerUtil   PACKAGE=guess
196 ap_error_log2stderr
197?ap_replace_stderr_log
198
199#MODULE=Apache2::ServerConfig
200#XXX: thought this might be useful
201#however it is not exported on win32
202!ap_get_local_host
203~ap_get_server_built
204~ap_server_root
205
206
207MODULE=Apache2::Connection   PACKAGE=guess
208#XXX: thought this might be useful for protocol modules
209#however it is not exported on win32
210!ap_read_request
211>ap_update_vhost_given_ip
212 mpxs_Apache2__Connection_get_remote_host | | c, type=REMOTE_NAME, dir_config=NULL
213
214MODULE=Apache2::Log   PACKAGE=guess
215?ap_log_assert
216~ap_log_error
217-ap_log_perror
218~ap_log_rerror
219>ap_open_stderr_log
220>ap_open_logs
221
222PACKAGE=Apache2::Log    PREFIX=ap_
223 ap_log_pid
224
225MODULE=Apache2::Module
226 module *:DEFINE_top_module
227-ap_add_loaded_module
228-ap_add_module
229-ap_add_named_module
230 ap_find_linked_module
231-ap_find_module_name
232ap_remove_loaded_module
233-ap_remove_module
234>ap_single_module_configure
235>ap_setup_prelinked_modules
236>ap_show_directives
237>ap_show_modules
238>ap_register_hooks
239 mpxs_Apache2__Module_loaded
240 mpxs_Apache2__Module_add
241 #ap_get_module_config
242 mpxs_Apache2__Module_get_config | | pmodule, s, v=NULL
243 mpxs_Apache2__Module_ap_api_major_version
244 mpxs_Apache2__Module_ap_api_minor_version
245
246MODULE=Apache2::Directive
247 ap_directive_t *:DEFINE_conftree
248!ap_add_node
249!ap_build_config
250!ap_build_cont_config
251!ap_walk_config
252>ap_process_config_tree
253
254MODULE=Apache2::Filter PACKAGE=guess
255~ap_add_output_filter
256~ap_add_input_filter
257-ap_add_input_filter_handle
258-ap_get_input_filter_handle
259-ap_add_output_filter_handle
260-ap_get_output_filter_handle
261>ap_add_ouput_filters_by_type
262~ap_get_brigade
263 mpxs_Apache2__Filter_get_brigade | | \
264               f, bb, mode=AP_MODE_READBYTES, \
265               block=APR_BLOCK_READ, \
266               readbytes=8192
267~ap_pass_brigade
268 mpxs_Apache2__Filter_pass_brigade
269!ap_register_input_filter
270!ap_register_output_filter
271-ap_remove_output_filter
272-ap_remove_input_filter
273!ap_save_brigade
274 ap_filter_flush
275~ap_fflush
276 mpxs_Apache2__Filter_fflush
277-ap_fputstrs
278#int:DEFINE_ap_fputs | | \
279#     ap_filter_t *:f, apr_bucket_brigade *:bb, const char *:str
280-ap_fprintf
281>ap_byterange_filter
282>ap_http_header_filter
283>ap_content_length_filter
284>ap_old_write_filter
285
286!MODULE=Apache2::Bucket
287 ap_bucket_error_create
288 ap_bucket_error_make
289
290!MODULE=Apache2::Base64
291 ap_pbase64decode
292 ap_pbase64encode
293
294!MODULE=Apache2::ConfigFile
295 ap_cfg_closefile
296 ap_cfg_getc
297 ap_cfg_getline
298 ap_pcfg_open_custom
299 ap_pcfg_openfile
300>ap_read_config
301>ap_merge_per_dir_configs
302>ap_create_conn_config
303>ap_parse_htaccess
304>ap_process_resource_config
305
306MODULE=Apache2::Command
307 command_rec *:DEFINE_next | | command_rec *:cmd
308-ap_soak_end_container
309-ap_set_int_slot
310-ap_set_file_slot
311-ap_set_flag_slot
312-ap_set_string_slot
313-ap_set_string_slot_lower
314-ap_set_deprecated
315
316MODULE=Apache2::Util
317 ap_ht_time | | p, t=TIME_NOW, fmt=DEFAULT_TIME_FORMAT, gmt=1
318!ap_rfc1413
319!ap_escape_html | | s, p
320 #escape_uri
321 ap_os_escape_path | | path, p, partial=TRUE | escape_path
322!ap_explode_recent_gmt
323!ap_explode_recent_localtime
324!ap_recent_ctime
325!ap_recent_rfc822_date
326
327MODULE=Apache2::URI   PACKAGE=guess
328 ap_parse_uri
329 ap_construct_url    | | r, uri=r->uri, p=r->pool
330 ap_construct_server | | r, hostname=ap_get_server_name(r), \
331                         port=ap_get_server_port(r), p=r->pool
332PACKAGE=Apache2::URI
333 char *:ap_unescape_url | mpxs_ | SV *:url
334
335PACKAGE=Apache2::RequestRec
336 mpxs_Apache2__RequestRec_parsed_uri
337
338!MODULE=Apache2::StringUtil   PACKAGE=guess
339 ap_count_dirs
340 ap_escape_path_segment
341 ap_escape_quotes
342 ap_escape_shell_cmd
343 ap_field_noparam
344 ap_find_last_token
345 ap_find_list_item
346 ap_find_token
347 ap_get_list_item
348 ap_size_list_item
349 ap_getparents
350 ap_get_token
351-ap_getword
352-ap_getword_conf
353-ap_getword_conf_nc
354-ap_getword_nc
355-ap_getword_nulls
356-ap_getword_nulls_nc
357-ap_getword_white
358-ap_getword_white_nc
359-ap_ind
360-ap_rind
361 ap_is_directory
362 ap_is_matchexp
363 ap_is_rdirectory
364 ap_is_url
365 ap_make_dirstr_parent
366 ap_make_dirstr_prefix
367 ap_make_full_path
368 ap_no2slash
369 ap_os_is_path_absolute
370 ap_resolve_env
371-ap_strcasecmp_match
372-ap_strcasestr
373-ap_strcmp_match
374 ap_stripprefix
375-ap_str_tolower
376
377!MODULE=Apache2::MethodList
378 ap_clear_method_list
379-ap_copy_method_list
380 ap_make_method_list
381 ap_method_in_list
382 ap_method_list_add
383 ap_method_list_do
384 ap_method_list_remove
385 ap_method_list_vdo
386 ap_method_name_of
387 ap_method_number_of
388
389!MODULE=Apache2::PipedLog
390 ap_close_piped_log
391 ap_open_piped_log
392
393!MODULE=Apache2::Scoreboard
394 ap_exists_scoreboard_image
395-ap_update_child_status
396-ap_time_process_request
397-ap_create_scoreboard
398 ap_cleanup_scoreboard
399 ap_increment_counts
400 ap_calc_scoreboard_size
401 ap_create_sb_handle
402 ap_get_scoreboard_global
403 ap_get_scoreboard_process
404 ap_get_scoreboard_worker
405>ap_init_scoreboard
406>ap_reopen_scoreboard
407 ap_update_child_status_from_indexes
408
409!MODULE=Apache2::Hooks
410 ap_location_walk
411 ap_directory_walk
412 ap_file_walk
413 ap_hook_access_checker
414 ap_hook_auth_checker
415 ap_hook_check_user_id
416 ap_hook_child_init
417>ap_hook_create_connection
418>ap_hook_get_create_connection
419 ap_hook_default_port
420 ap_hook_fixups
421 ap_hook_handler
422 ap_hook_header_parser
423 ap_hook_http_method
424 ap_hook_insert_filter
425 ap_hook_log_transaction
426 ap_hook_open_logs
427 ap_hook_optional_fn_retrieve
428 ap_hook_post_config
429 ap_hook_post_read_request
430 ap_hook_pre_config
431 ap_hook_pre_connection
432 ap_hook_process_connection
433 ap_hook_translate_name
434 ap_hook_type_checker
435!ap_hook_quick_handler
436 ap_hook_map_to_storage
437 ap_hook_create_request
438 ap_hook_error_log
439>ap_hook_pre_mpm
440-ap_hook_get_suexec_identity
441-ap_hook_get_access_checker
442-ap_hook_get_auth_checker
443-ap_hook_get_check_user_id
444-ap_hook_get_child_init
445-ap_hook_get_create_request
446-ap_hook_get_default_port
447-ap_hook_get_error_log
448-ap_hook_get_fixups
449-ap_hook_get_get_mgmt_items
450-ap_hook_get_get_suexec_identity
451-ap_hook_get_handler
452-ap_hook_get_header_parser
453-ap_hook_get_http_method
454-ap_hook_get_insert_filter
455-ap_hook_get_log_transaction
456-ap_hook_get_map_to_storage
457-ap_hook_get_mgmt_items
458-ap_hook_get_open_logs
459-ap_hook_get_optional_fn_retrieve
460-ap_hook_get_post_config
461-ap_hook_get_post_read_request
462-ap_hook_get_pre_config
463-ap_hook_get_pre_connection
464-ap_hook_get_pre_mpm
465-ap_hook_get_process_connection
466-ap_hook_get_quick_handler
467-ap_hook_get_translate_name
468-ap_hook_get_type_checker
469
470MODULE=Apache2::HookRun   PACKAGE=guess
471-ap_run_get_suexec_identity
472-ap_run_optional_fn_retrieve
473>ap_run_pre_config
474>ap_run_open_logs
475>ap_run_post_config
476>ap_run_insert_filter
477>ap_run_child_init
478?ap_run_default_port
479?ap_run_http_method
480>ap_run_create_connection
481>ap_run_pre_connection
482>ap_run_process_connection
483 ap_run_post_read_request
484 ap_run_translate_name
485 ap_run_header_parser
486 ap_run_access_checker
487 ap_run_check_user_id
488 ap_run_auth_checker
489 ap_run_type_checker
490 ap_run_fixups
491 ap_run_handler
492 ap_run_log_transaction
493>ap_run_rewrite_args
494?ap_run_create_request
495>ap_run_error_log
496>ap_run_get_mgmt_items
497 ap_run_map_to_storage
498>ap_run_pre_mpm
499!ap_run_quick_handler
500 ap_invoke_handler
501 ap_die | | r, type
502
503!MODULE=Apache2::MD5
504 ap_md5
505 ap_md5_binary
506 ap_md5contextTo64
507 ap_md5digest
508
509-MODULE=Apache2::Regexp
510 ap_pregcomp
511 ap_pregfree
512 ap_pregsub
513 ap_regerror
514 ap_regexec
515
516!MODULE=Apache2::VHost
517-ap_set_name_virtual_host
518-ap_fini_vhost_config
519-ap_init_vhost_config
520 ap_matches_request_vhost
521 ap_parse_vhost_addrs
522-ap_update_vhost_from_headers
523-ap_fixup_virtual_hosts
524
525!MODULE=Apache2::HTTPCore
526>ap_process_request
527>ap_make_content_type
528>ap_core_reorder_directories
529>ap_index_of_response
530
531!MODULE=Apache2::XML
532 ap_xml_parse_input
533
534MODULE=Apache2::MPM   PACKAGE=Apache2::MPM   BOOT=1
535~ap_mpm_query
536~ap_show_mpm
537>ap_mpm_run
538?ap_os_create_privileged_process
539?ap_wait_or_timeout
540?ap_graceful_stop_signalled
541?ap_process_child_status
542?ap_reclaim_child_processes
543?ap_sock_disable_nagle
544?ap_gname2id
545?ap_uname2id
546?ap_lingering_close
547?ap_mpm_pod_check
548?ap_mpm_pod_close
549?ap_mpm_pod_killpg
550?ap_mpm_pod_open
551?ap_mpm_pod_signal
552?ap_mpm_set_accept_lock_mech
553?ap_mpm_set_coredumpdir
554?ap_mpm_set_lockfile
555?ap_mpm_set_max_requests
556?ap_mpm_set_pidfile
557?ap_mpm_set_scoreboard
558?ap_listen_pre_config
559
560#_if_ do {                                                                  \
561          Apache2::Build->build_config                                      \
562	      ->httpd_version =~ /^(\d+)\.(\d+)\.(\d+)/                     \
563          ? ($1*1000+$2)*1000+$3                                            \
564          : die "Cannot get httpd version";                                 \
565      } > 2003000
566MODULE=Apache2::Provider
567 ap_register_provider
568#_end_
569