display.h File Reference

#include "target.h"

Include dependency graph for display.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	OutputFmt {   FMT_PLAIN = 0 , FMT_XTERM , FMT_VERBOSE , FMT_INDEP ,   FMT_HTML }

Functions
void	set_output_format (enum OutputFmt format)

Variables
void(*	set_header )(const char *format)
void(*	print_header )(const char *const argv[])
void(*	print_target )(const struct target_opts *options)
void(*	set_progress )(int time)
void(*	print_status )(const struct target_status *status)
void(*	print_footer )(int count, const struct target_status *status)

Enumeration Type Documentation

OutputFmt

enum OutputFmt

display.h - Interface declaration for the result display subsystem

$Id$

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Output format mode enumeration.

Used to determine the mode used in producing output.

Enumerator
FMT_PLAIN	plain text output.
FMT_XTERM	xterm colored output.
FMT_VERBOSE	verbose text output.
FMT_INDEP	Non-targeted formated output.
FMT_HTML	HTML formated output.

Definition at line 37 of file display.h.

Function Documentation

set_output_format()

void set_output_format

(

enum OutputFmt

format

)

Sets the output functions referenced.

Definition at line 371 of file display.cpp.

Variable Documentation

print_footer

void(* print_footer) (int count, const struct target_status *status) ( int  count, const struct target_status *  status  )

extern

Prints the closing formatting for the table.

Definition at line 394 of file display.cpp.

print_header

void(* print_header) (const char *const argv[]) ( const char *const  argv[] )

extern

Prints the table preamble formatting, followed by the formatted header row.

Definition at line 391 of file display.cpp.

print_status

void(* print_status) (const struct target_status *status) ( const struct target_status *  status )

extern

Prints the formatted results for a target row.

Parameters

status

describes the results of the run

Definition at line 393 of file display.cpp.

print_target

void(* print_target) (const struct target_opts *options) ( const struct target_opts *  options )

extern

Prints the formatted header column for a target row.

This method uses the target_name global (defined in cmdopt.h), and flushes stdout after printing.

See also

target_name

Definition at line 392 of file display.cpp.

set_header

void(* set_header) (const char *format) ( const char *  format )

extern

Sets the column order and widths (if applicable) for output.

Parameters

format

custom format string for output.

set_progress

void(* set_progress) (int time) ( int  time )

extern

Updates the display of a (non-final) status indicator

This function is only useful for FMT_XTERM.

Parameters

time	0 > time indicates -signal number, otherwise time remaining