Core Function Scanf - Revision history

UberFoX: 1 revision

2015-06-14T12:37:17Z

1 revision

← Older revision

Revision as of 12:37, 14 June 2015

UberFoX: 1 revision

2014-08-11T21:40:56Z

1 revision

← Older revision

Revision as of 21:40, 11 August 2014

UberFoX: /* The scanf() Format String */

2013-01-22T19:31:47Z

The scanf() Format String

← Older revision		Revision as of 19:31, 22 January 2013
Line 71:		Line 71:

	Items within square brackets ([]) are optional. The following table describes elements within the format specifier.		Items within square brackets ([]) are optional. The following table describes elements within the format specifier.
		+
		+	<pre>
		+	Element Meaning
		+	* Indicates that this field is parsed normally but not stored in a variable.
		+	width Specifies the maximum number of characters to be read for this field.
		+	modifiers If supplied, modifies the size of the data type where the field is stored.
		+	If not supplied, the default size is used. Supported modifiers are listed
		+	below.
		+	hh: For integer fields, the result is stored in an 8-bit variable.
		+	Ignored for floating point fields.
		+	h: For integer fields, the result is stored in a 16-bit variable.
		+	Ignored for floating point fields.
		+	l For integer fields, the result is stored in a 64-bit variable. Floating
		+	point fields are stored in a double.
		+	ll Same effect as the l modifier.
		+	width Specifies the maximum number of characters to include in this field.
		+	type Specifies the field type as described in the following table.
		+	</pre>
		+
		+	<pre>
		+	Type Meaning
		+	c Reads a single character. If a width > 1 is specified, an array of
		+	characters is read.
		+	d, i Reads a decimal integer. Number may begin with 0 (octal),
		+	0x (hexadecimal) or a + or - sign.
		+	e, E, f, g,G Reads a floating point variable. Number may begin with a + or - sign,
		+	and may be written using exponential notation.
		+	o Reads an unsigned octal integer
		+	s Reads a string of characters up to the end of the input string, the
		+	next whitespace character, or until the number of characters specified
		+	for the width has been read.
		+	u Reads an unsigned decimal integer. Number may begin with 0 (octal),
		+	0x (hexadecimal) or a + sign.
		+	x, X Reads an unsigned hexadecimal integer.
		+	[] Reads a string of characters that are included within square brackets.
		+	For example, "[abc]" will read all characters that are either a, b, or c.
		+	Use "[^abc]" to read all character that are not a, b, or c. If the
		+	first character after "[" or after "[^" is "]", the closing square bracket
		+	is considered to be one of the characters rather than the end of the scanset.
		+	This supports macros such as [a-z] will read any letter between a-z so if you
		+	wanted to read only hex chars you could enter [a-zA-Z0-9] and it would work.
		+	</pre>

	=== Example ===		=== Example ===

UberFoX: /* The scanf() Format String */

2013-01-22T19:26:29Z

The scanf() Format String

← Older revision		Revision as of 19:26, 22 January 2013
Line 53:		Line 53:
	The scanf() format string provides a flexible way to describe the fields in the input string. Although there are standards, different C compilers seemed to have slightly different rules about the meaning of some parts of the format string. The following definition is for format strings used by the this scanf().		The scanf() format string provides a flexible way to describe the fields in the input string. Although there are standards, different C compilers seemed to have slightly different rules about the meaning of some parts of the format string. The following definition is for format strings used by the this scanf().

−		+	<pre>
	Characters Description		Characters Description
	Whitespace Any whitespace characters in the format string causes		Whitespace Any whitespace characters in the format string causes
Line 67:		Line 67:
	format specifier, or field, that will be parsed and stored		format specifier, or field, that will be parsed and stored
	in a variable. A format specifier has the following form.		in a variable. A format specifier has the following form.
−		+	</pre>
	%[*][width][modifiers]type		%[*][width][modifiers]type

UberFoX: /* Remarks */

2013-01-22T19:26:12Z

Remarks

← Older revision		Revision as of 19:26, 22 January 2013
Line 40:		Line 40:

	If there are more substrings expected in the format than there are available within str, they will be ignored and you will get what did match.		If there are more substrings expected in the format than there are available within str, they will be ignored and you will get what did match.
		+
		+	C and C++ developers have used the scanf() family of functions (scanf(), sscanf(), fscanf(), etc.) as a quick and easy way to parse well-structured input. The basic idea is to be able to specify the format of an input string in a way that allows the function to extract fields from that string.
		+
		+	For example, if your input string is "X123 Y456", you could specify a format string of "X%d Y%d" to extract the two numeric values, 123 and 456. The "%d" tells the function to extract a decimal value at the current location. The parser reads the decimal value until a non-digit character is encountered. The values are then assigned to variables and returned to the caller. In this example, the X and Y are character literals. These are characters in the input string expected to match the same characters in the format string.
		+
		+	Processing stops either when the end of the format string is reached, or when characters in the input string cannot be processed according to the format string.
		+
		+	To be sure, there are limits to this approach. For example, you wouldn't use scanf() to parse source code. It works best will well-structured input that can readily be defined into fields. Thoes who like the regular expressions can use those for parsing well-structured text. However, for cases where scanf() works, or for developers who are accustomed to using scanf(), it provides a simple and convenient way to parse many types of text.
		+
		+	==== The scanf() Format String ====
		+
		+	The scanf() format string provides a flexible way to describe the fields in the input string. Although there are standards, different C compilers seemed to have slightly different rules about the meaning of some parts of the format string. The following definition is for format strings used by the this scanf().
		+
		+
		+	Characters Description
		+	Whitespace Any whitespace characters in the format string causes
		+	the position to advance to the next non-whitespace character
		+	in the input string. Whitespace characters include spaces,
		+	tabs and new lines.
		+
		+	Non-Whitespace except percent (%) Any character that is not a whitespace character or part of a
		+	format specifier (which begins with a % character) advances
		+	past the same matching character in the input string.
		+
		+	Format specifier A sequence that begins with a percent sign (%) to signify a
		+	format specifier, or field, that will be parsed and stored
		+	in a variable. A format specifier has the following form.
		+
		+	%[*][width][modifiers]type
		+
		+	Items within square brackets ([]) are optional. The following table describes elements within the format specifier.

	=== Example ===		=== Example ===

UberFoX: /* Example */

2013-01-22T17:46:58Z

Example

← Older revision		Revision as of 17:46, 22 January 2013
Line 51:		Line 51:
	</syntaxhighlight>		</syntaxhighlight>

−	~~Example #1 sscanf() Example~~	+	Not using optional parameters
	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
	// getting the serial number		// getting the serial number
Line 61:		Line 61:
	</syntaxhighlight>		</syntaxhighlight>

−	~~Example #2 sscanf() - using~~ optional parameters	+	Using optional parameters
	If optional parameters are passed, the function will return the number of assigned values.		If optional parameters are passed, the function will return the number of assigned values.
	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">

UberFoX: /* If sing the extra params */

2013-01-22T17:42:32Z

If sing the extra params

← Older revision		Revision as of 17:42, 22 January 2013
Line 23:		Line 23:
	=== Return Value ===		=== Return Value ===

−	==== If ~~sing~~ the extra params ====	+	==== If using the extra params ====

	Success: Returns number of matches and fills in the extra variables (Will make some 0 if there was no match found for that variable).		Success: Returns number of matches and fills in the extra variables (Will make some 0 if there was no match found for that variable).

	Failure: Returns 0.		Failure: Returns 0.
−

	==== If NOT using the extra params ====		==== If NOT using the extra params ====

UberFoX: /* Return Value */

2013-01-22T17:42:17Z

Return Value

← Older revision		Revision as of 17:42, 22 January 2013
Line 22:		Line 22:

	=== Return Value ===		=== Return Value ===
		+
		+	==== If sing the extra params ====
		+
		+	Success: Returns number of matches and fills in the extra variables (Will make some 0 if there was no match found for that variable).
		+
		+	Failure: Returns 0.
		+
		+
		+	==== If NOT using the extra params ====

	Success: Returns array of all captured objects from the parsed string.		Success: Returns array of all captured objects from the parsed string.

UberFoX: /* Example */

2013-01-22T17:32:53Z

Example

← Older revision		Revision as of 17:32, 22 January 2013
Line 70:		Line 70:
	$out = scanf('file_name.gif', 'file_%[^.].%s', $fpart1, $fpart2);		$out = scanf('file_name.gif', 'file_%[^.].%s', $fpart1, $fpart2);
	println("Name '$fpart1' Ext '$fpart2'");		println("Name '$fpart1' Ext '$fpart2'");
		+	</syntaxhighlight>
		+
		+	Example of using [] to spawn a character set
		+
		+	<syntaxhighlight lang="sputnik">
		+	$date = 'january-2008';
		+	// notice it is scanning for all characters a-z and uppercase A-Z
		+	// so it will match any case of the month name
		+	Scanf($date, '%[a-zA-Z]-%d', $month, $year);
		+	println("Parsed values: '$month', '$year'");
	</syntaxhighlight>		</syntaxhighlight>

	[[Category:Core Function]]		[[Category:Core Function]]

UberFoX: /* Example */

2013-01-22T16:56:11Z

Example

← Older revision		Revision as of 16:56, 22 January 2013
Line 65:		Line 65:
	</syntaxhighlight>		</syntaxhighlight>

−	Example of how ~~%s will stop if it finds the next thing you want~~ to parse ~~such as~~ a .	+	Example of how to parse a file name without getting the . trapped inside the first %s

	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
−	~~// Heres an example of how the parser will stop not just on whitespace~~	+	$out = scanf('file_name.gif', 'file_%[^.].%s', $fpart1, $fpart2);
−	~~// but also on what it needs to parse next for example~~	+
−	~~// 'file_%s.%s' means find file_ then STRING then . then STRING~~	+
−	~~// in most Scanf stuff such as PHPs you would get NULL for second variable~~	+
−	~~// but in Sputnik you will get the file extension in the second variable properly~~	+
−	~~// this is because when it starts searching for the first string it will stop~~	+
−	~~// if it finds a . (since . comes after the %s in the format!)~~	+
−	$out = ~~Scanf~~('file_name.gif', 'file_%s.%s', $fpart1, $fpart2);	+
	println("Name '$fpart1' Ext '$fpart2'");		println("Name '$fpart1' Ext '$fpart2'");
	</syntaxhighlight>		</syntaxhighlight>

	[[Category:Core Function]]		[[Category:Core Function]]