utils/mapitest/mapitest_print.c File Reference

Print / display functions for mapitest output. More...

Defines

#define CNT_DEINDENT()   { count--; if (count < 0) count = 0; }
#define CNT_INDENT()   { count++; }
#define CNT_PRINT(s)   { int i; for (i = 0; i < count; i++) { fprintf(s, "\t"); } }

Functions

void mapitest_deindent (void)
void mapitest_indent (void)
void mapitest_print (struct mapitest *mt, const char *format,...)
void mapitest_print_headers (struct mapitest *mt)
void mapitest_print_headers_info (struct mapitest *mt)
void mapitest_print_headers_server_info (struct mapitest *mt)
void mapitest_print_line (struct mapitest *mt, int len, char delim)
void mapitest_print_module_title_end (struct mapitest *mt)
void mapitest_print_module_title_start (struct mapitest *mt, const char *str)
void mapitest_print_newline (struct mapitest *mt, int count)
void mapitest_print_retval (struct mapitest *mt, char *name)
void mapitest_print_retval_fmt (struct mapitest *mt, char *name, const char *format,...)
void mapitest_print_retval_step (struct mapitest *mt, char *step, char *name)
void mapitest_print_retval_step_fmt (struct mapitest *mt, char *step, char *name, const char *format,...)
void mapitest_print_tab (struct mapitest *mt)
void mapitest_print_test_result (struct mapitest *mt, char *name, bool ret)
void mapitest_print_test_title_end (struct mapitest *mt)
void mapitest_print_test_title_start (struct mapitest *mt, const char *str)
void mapitest_print_title (struct mapitest *mt, const char *str, char delim)
void mapitest_underline (struct mapitest *mt, const char *str, char delim)

Detailed Description

Print / display functions for mapitest output.


Define Documentation

#define CNT_DEINDENT (  )     { count--; if (count < 0) count = 0; }

Referenced by mapitest_deindent().

#define CNT_INDENT (  )     { count++; }

Referenced by mapitest_indent().

#define CNT_PRINT (   s  )     { int i; for (i = 0; i < count; i++) { fprintf(s, "\t"); } }

Referenced by mapitest_print_tab().


Function Documentation

void mapitest_print ( struct mapitest mt,
const char *  format,
  ... 
)

Print a string in the stream

Parameters:
mt pointer to the top-level mapitest structure
format the format string
... the format string parameters

References mapitest_print_tab(), and mapitest::stream.

Referenced by mapitest_common_cleanup(), mapitest_common_create_filled_test_folder(), mapitest_common_folder_open(), mapitest_common_message_create(), mapitest_common_message_delete_by_subject(), mapitest_common_message_fill(), mapitest_errorchecks_simplemapi_c(), mapitest_lcid_langcode2langtag(), mapitest_mapidump_freebusy(), mapitest_mapidump_task(), mapitest_noserver_lzfu(), mapitest_noserver_mapi_properties(), mapitest_noserver_proptagvalue(), mapitest_noserver_srowset(), mapitest_nspi_CompareMIds(), mapitest_nspi_GetPropList(), mapitest_nspi_QueryColumns(), mapitest_nspi_UpdateStat(), mapitest_oxcfold_CopyFolder(), mapitest_oxcfold_CreateFolder(), mapitest_oxcfold_HardDeleteMessages(), mapitest_oxcfold_HardDeleteMessagesAndSubfolders(), mapitest_oxcfold_MoveFolder(), mapitest_oxcfold_OpenFolder(), mapitest_oxcfxics_GetLocalReplicaIds(), mapitest_oxcmsg_GetValidAttachments(), mapitest_oxcmsg_OpenEmbeddedMessage(), mapitest_oxcmsg_SetMessageReadFlag(), mapitest_oxcmsg_SetMessageStatus(), mapitest_oxcmsg_SetReadFlags(), mapitest_oxcprpt_CopyProps(), mapitest_oxcprpt_CopyTo(), mapitest_oxcprpt_CopyToStream(), mapitest_oxcprpt_DeleteProps(), mapitest_oxcprpt_NameId(), mapitest_oxcprpt_NoReplicate(), mapitest_oxcprpt_SetProps(), mapitest_oxcprpt_Stream(), mapitest_oxcprpt_WriteAndCommitStream(), mapitest_oxcstor_GetOwningServers(), mapitest_oxcstor_LongTermId(), mapitest_oxcstor_PublicFolderIsGhosted(), mapitest_oxctable_Category(), mapitest_oxctable_GetStatus(), mapitest_oxctable_QueryColumns(), mapitest_oxctable_QueryRows(), mapitest_oxctable_Restrict(), mapitest_oxomsg_AddressTypes(), mapitest_oxomsg_SpoolerLockMessage(), mapitest_oxomsg_TransportSend(), mapitest_print_headers_info(), mapitest_print_headers_server_info(), mapitest_print_module_title_start(), mapitest_print_retval(), mapitest_print_retval_fmt(), mapitest_print_retval_step(), mapitest_print_retval_step_fmt(), mapitest_print_test_result(), mapitest_print_test_title_start(), and mapitest_stat_dump().

void mapitest_print_headers ( struct mapitest mt  ) 

Print mapitest report headers

Parameters:
mt pointer to the top-level mapitest structure

References mapitest_deindent(), mapitest_indent(), mapitest_print_headers_info(), mapitest_print_headers_server_info(), mapitest_print_newline(), and mapitest::no_server.

Referenced by main().

void mapitest_print_headers_info ( struct mapitest mt  ) 

Print mapitest report headers information

Parameters:
mt pointer to the top-level mapitest structure

References mapitest::confidential, mapitest_deindent(), mapitest_indent(), mapitest_print(), mapitest_print_newline(), MT_HDR_FMT, MT_HDR_FMT_DATE, MT_HDR_FMT_SECTION, MT_HDR_FMT_SUBSECTION, MT_NO, and MT_YES.

Referenced by mapitest_print_headers().

void mapitest_print_headers_server_info ( struct mapitest mt  ) 

Print a report of the Exchange server and account information

Parameters:
mt pointer to the top-level mapitest structure

References mapitest::confidential, mapitest::info, mapitest_deindent(), mapitest_indent(), mapitest_print(), mapitest_print_newline(), MT_CONFIDENTIAL, MT_HDR_FMT_SECTION, MT_HDR_FMT_SUBSECTION, mapitest::online, mapitest::org, and mapitest::org_unit.

Referenced by mapitest_print_headers().

void mapitest_print_line ( struct mapitest mt,
int  len,
char  delim 
)

Print a line using a delimiter

Parameters:
mt pointer to the top-level mapitest structure
len the length of the line to print
delim the line delimiter

References mapitest_print_newline(), and mapitest::stream.

Referenced by mapitest_print_module_title_end(), mapitest_print_module_title_start(), mapitest_print_test_result(), mapitest_print_test_title_end(), mapitest_print_test_title_start(), and mapitest_underline().

void mapitest_print_module_title_end ( struct mapitest mt  ) 

Print the content at the end of the module

Parameters:
mt pointer to the top-level mapitest structure

References mapitest_deindent(), mapitest_print_line(), mapitest_print_newline(), mapitest_print_tab(), MODULE_TITLE_DELIM, MODULE_TITLE_LINELEN, and MODULE_TITLE_NEWLINE.

Referenced by mapitest_run_all().

void mapitest_print_module_title_start ( struct mapitest mt,
const char *  str 
)

Print the module title

Parameters:
mt pointer to the top-level mapitest structure
str the module title string

References mapitest_indent(), mapitest_print(), mapitest_print_line(), mapitest_print_tab(), mapitest::mem_ctx, MODULE_TITLE, MODULE_TITLE_DELIM, and MODULE_TITLE_LINELEN.

Referenced by mapitest_run_all().

void mapitest_print_newline ( struct mapitest mt,
int  count 
)

Print newline characters

Parameters:
mt pointer to the top-level mapitest structure
count number of newline characters to print

References mapitest::stream.

Referenced by mapitest_print_headers(), mapitest_print_headers_info(), mapitest_print_headers_server_info(), mapitest_print_line(), mapitest_print_module_title_end(), and mapitest_print_test_result().

void mapitest_print_retval ( struct mapitest mt,
char *  name 
)

Print mapitest return value

Parameters:
mt pointer to the top-level mapitest structure
name the test name
See also:
mapitest_print_retval_fmt for a version providing an additional format string

References mapitest::color, mapitest_print(), MT_GREEN, MT_RED, and MT_WHITE.

Referenced by mapitest_common_create_filled_test_folder(), mapitest_common_message_delete_by_subject(), mapitest_common_setup(), mapitest_noserver_lzfu(), mapitest_nspi_CompareMIds(), mapitest_nspi_DNToMId(), mapitest_nspi_GetIDsFromNames(), mapitest_nspi_GetMatches(), mapitest_nspi_GetNamesFromIDs(), mapitest_nspi_GetPropList(), mapitest_nspi_GetProps(), mapitest_nspi_GetSpecialTable(), mapitest_nspi_GetTemplateInfo(), mapitest_nspi_ModLinkAtt(), mapitest_nspi_ModProps(), mapitest_nspi_QueryColumns(), mapitest_nspi_QueryRows(), mapitest_nspi_ResolveNames(), mapitest_nspi_ResortRestriction(), mapitest_nspi_SeekEntries(), mapitest_nspi_UpdateStat(), mapitest_oxcfold_CopyFolder(), mapitest_oxcfold_CreateFolder(), mapitest_oxcfold_GetContentsTable(), mapitest_oxcfold_GetHierarchyTable(), mapitest_oxcfold_GetSearchCriteria(), mapitest_oxcfold_HardDeleteMessages(), mapitest_oxcfold_HardDeleteMessagesAndSubfolders(), mapitest_oxcfold_MoveCopyMessages(), mapitest_oxcfold_MoveFolder(), mapitest_oxcfold_OpenFolder(), mapitest_oxcfold_SetSearchCriteria(), mapitest_oxcfxics_GetLocalReplicaIds(), mapitest_oxcmsg_CreateMessage(), mapitest_oxcmsg_GetMessageStatus(), mapitest_oxcmsg_ModifyRecipients(), mapitest_oxcmsg_ReadRecipients(), mapitest_oxcmsg_ReloadCachedInformation(), mapitest_oxcmsg_RemoveAllRecipients(), mapitest_oxcmsg_SaveChangesMessage(), mapitest_oxcmsg_SetMessageReadFlag(), mapitest_oxcmsg_SetMessageStatus(), mapitest_oxcmsg_SetReadFlags(), mapitest_oxcnotif_RegisterNotification(), mapitest_oxcprpt_CopyTo(), mapitest_oxcprpt_CopyToStream(), mapitest_oxcprpt_GetPropList(), mapitest_oxcprpt_GetProps(), mapitest_oxcprpt_GetPropsAll(), mapitest_oxcprpt_NameId(), mapitest_oxcprpt_Stream(), mapitest_oxcprpt_WriteAndCommitStream(), mapitest_oxcstor_GetOwningServers(), mapitest_oxcstor_GetReceiveFolder(), mapitest_oxcstor_GetReceiveFolderTable(), mapitest_oxcstor_GetStoreState(), mapitest_oxcstor_Logon(), mapitest_oxcstor_LongTermId(), mapitest_oxcstor_PublicFolderIsGhosted(), mapitest_oxctable_Category(), mapitest_oxctable_GetStatus(), mapitest_oxctable_QueryColumns(), mapitest_oxctable_QueryRows(), mapitest_oxctable_Restrict(), mapitest_oxctable_SeekRowBookmark(), mapitest_oxctable_SetColumns(), mapitest_oxomsg_AbortSubmit(), mapitest_oxomsg_SetSpooler(), mapitest_oxomsg_SpoolerLockMessage(), mapitest_oxomsg_SubmitMessage(), mapitest_oxomsg_TransportNewMail(), mapitest_oxomsg_TransportSend(), and mapitest_oxorule_GetRulesTable().

void mapitest_print_retval_step ( struct mapitest mt,
char *  step,
char *  name 
)

Print mapitest return value for a given step

Parameters:
mt pointer tp the top-level mapitest structure
step the test step
name the test name
See also:
mapitest_print_retval_step_fmt for a version providing an additional format string

References mapitest::color, mapitest_print(), MT_GREEN, MT_RED, and MT_WHITE.

Referenced by mapitest_oxcprpt_CopyProps(), mapitest_oxcprpt_DeleteProps(), mapitest_oxcprpt_NoReplicate(), and mapitest_oxcstor_SetReceiveFolder().

void mapitest_print_retval_step_fmt ( struct mapitest mt,
char *  step,
char *  name,
const char *  format,
  ... 
)

Print mapitest return value for a given step with additional format string

Parameters:
mt pointer to the top-level mapitest structure
step the test step
name the test name
format the format string
... the format string parameters

References mapitest::color, mapitest_print(), MT_GREEN, MT_RED, and MT_WHITE.

Referenced by mapitest_oxcprpt_CopyProps(), mapitest_oxcprpt_DeleteProps(), mapitest_oxcprpt_NoReplicate(), mapitest_oxcprpt_SetProps(), and mapitest_oxcstor_SetReceiveFolder().

void mapitest_print_tab ( struct mapitest mt  ) 

Print tabulations given the internal counter

Parameters:
mt pointer to the top-level mapitest structure

References CNT_PRINT, and mapitest::stream.

Referenced by mapitest_print(), mapitest_print_module_title_end(), mapitest_print_module_title_start(), mapitest_print_test_result(), mapitest_print_test_title_end(), mapitest_print_test_title_start(), and mapitest_underline().

void mapitest_print_test_result ( struct mapitest mt,
char *  name,
bool  ret 
)

Print mapitest test result

Parameters:
mt pointer to the top-level mapitest structure
name the test name
ret boolean value with the test result

References mapitest_print(), mapitest_print_line(), mapitest_print_newline(), mapitest_print_tab(), MODULE_TEST_DELIM2, MODULE_TEST_FAILURE, MODULE_TEST_LINELEN, MODULE_TEST_NEWLINE, MODULE_TEST_RESULT, and MODULE_TEST_SUCCESS.

Referenced by mapitest_run_all(), and mapitest_suite_run_test().

void mapitest_print_test_title_end ( struct mapitest mt  ) 

Write the content at the end of a test

Parameters:
mt pointer to the top-level mapitest structure

References mapitest_deindent(), mapitest_print_line(), mapitest_print_tab(), MODULE_TEST_DELIM, and MODULE_TEST_LINELEN.

Referenced by mapitest_run_all(), mapitest_stat_dump(), and mapitest_suite_run_test().

void mapitest_print_test_title_start ( struct mapitest mt,
const char *  str 
)

print the test tile

Parameters:
mt pointer to the top-level mapitest structure
str the test title

References mapitest_indent(), mapitest_print(), mapitest_print_line(), mapitest_print_tab(), mapitest::mem_ctx, MODULE_TEST_DELIM, MODULE_TEST_LINELEN, and MODULE_TEST_TITLE.

Referenced by mapitest_run_all(), and mapitest_suite_run_test().

void mapitest_print_title ( struct mapitest mt,
const char *  str,
char  delim 
)

Private general routine used to print a title

Avoid code redundancy over the API

Parameters:
mt pointer to the top-level mapitest structure
str the title
delim the underline delimiter

References mapitest_indent(), and mapitest_underline().

Referenced by mapitest_stat_dump().

void mapitest_underline ( struct mapitest mt,
const char *  str,
char  delim 
)

Underline a string

Parameters:
mt pointer to the top-level mapitest structure
str string to underline
delim the line delimiter

References mapitest_print_line(), mapitest_print_tab(), and mapitest::stream.

Referenced by mapitest_print_title().


Creative Commons License
Creative Commons Attribution icon Creative Commons Share Alike icon
This content is licensed under the Creative Commons
Attribution ShareAlike License v. 3.0:
http://creativecommons.org/licenses/by-sa/3.0/