objects.h File Reference

Parse the Command Line. More...

#include <stdbool.h>
#include "mutt/lib.h"

Include dependency graph for objects.h:

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

Go to the source code of this file.

Data Structures
struct	CliShared
	Shared Command Line options. More...
struct	CliHelp
	Help Mode Command Line options. More...
struct	CliInfo
	Info Mode Command Line options. More...
struct	CliSend
	Send Mode Command Line options. More...
struct	CliTui
	TUI Mode Command Line options. More...
struct	CommandLine
	Command Line options. More...

Enumerations
enum	HelpMode {   HM_NONE , HM_SHARED , HM_HELP , HM_INFO ,   HM_SEND , HM_TUI , HM_ALL }
	Show detailed help. More...

Functions
struct CommandLine *	command_line_new (void)
	Create a new CommandLine.
void	command_line_free (struct CommandLine **ptr)
	Free a CommandLine.

Detailed Description

Parse the Command Line.

Authors

• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file objects.h.

Enumeration Type Documentation

HelpMode

enum HelpMode

Show detailed help.

Enumerator
HM_NONE	No extra help.
HM_SHARED	Help about shared config options.
HM_HELP	Help about help.
HM_INFO	Help about info options.
HM_SEND	Help about sending email options.
HM_TUI	Help about starting the tui options.
HM_ALL	Help about all options.

Definition at line 32 of file objects.h.

{
  HM_NONE,         
  HM_SHARED,       
  HM_HELP,         
  HM_INFO,         
  HM_SEND,         
  HM_TUI,          
  HM_ALL,          
};

Function Documentation

command_line_new()

struct CommandLine * command_line_new

(

void

)

Create a new CommandLine.

Return values

ptr	New CommandLine

Definition at line 105 of file objects.c.

{
  return MUTT_MEM_CALLOC(1, struct CommandLine);
}

Here is the caller graph for this function:

command_line_free()

void command_line_free

(

struct CommandLine **

ptr

)

Free a CommandLine.

Parameters

ptr	CommandLine to free

Definition at line 114 of file objects.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct CommandLine *cl = *ptr;
 
  // cl->help - nothing to do
  cli_shared_clear(&cl->shared);
  cli_info_clear(&cl->info);
  cli_send_clear(&cl->send);
  cli_tui_clear(&cl->tui);
 
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function: