Core Function StrNew - Revision history

UberFoX: /* Example */

2015-09-19T10:09:28Z

Example

← Older revision		Revision as of 10:09, 19 September 2015
Line 30:		Line 30:

	Normal string		Normal string
		+
	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
	$Str = StrNew('T', 15);		$Str = StrNew('T', 15);
Line 39:		Line 40:
	// OR		// OR
	// $Str = "AB" . ('T' x 13);		// $Str = "AB" . ('T' x 13);
		+	</syntaxhighlight>
		+
		+	You can create a string full of null terminators since Sputnik strings use a length property so a string can contain nulls etc (of course there is an actual null terminator at the end of the length) this means when you use StrNew() to create a string with say 100 length and all null terminators then the string will be 100 chars in size.
		+
		+	However you might want to eventually cut the string into the size you want it to be once you finish editing it to do that we can use TrimToNull() which will trim the string to first NULL it finds.
		+
		+	<syntaxhighlight lang="sputnik">
		+	$Str = StrNew(@'\0', 15);
		+	$Str[0] = 'A'; // Set first char to A
		+	$Str[1] = 'B'; // Set second char to B
		+	say $Str; // Prints: AB
		+	say StrLen($Str); // 15
		+
		+	// Lets fix the string so its no longer 15 in size
		+	// but fits all way to null term so 2 in size
		+	say "Trimming...";
		+	$Str = TrimToNull($Str);
		+	say $Str; // Prints: AB
		+	say StrLen($Str); // 2
	</syntaxhighlight>		</syntaxhighlight>

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

UberFoX at 10:00, 19 September 2015

2015-09-19T10:00:31Z

← Older revision		Revision as of 10:00, 19 September 2015
Line 33:		Line 33:
	$Str = StrNew('T', 15);		$Str = StrNew('T', 15);
	$Str[0] = 'A'; // Set first char to A		$Str[0] = 'A'; // Set first char to A
−	$Str[1] = 'A'; // Set second char to B	+	$Str[1] = 'B'; // Set second char to B
	echo $Str; // Prints: ABTTTTTTTTTTTTT		echo $Str; // Prints: ABTTTTTTTTTTTTT
	// Of course you could just make the string like		// Of course you could just make the string like
Line 39:		Line 39:
	// OR		// OR
	// $Str = "AB" . ('T' x 13);		// $Str = "AB" . ('T' x 13);
−	~~// The purpose of this function is just to make it more~~
−	~~// simple to create a string for use in Fixed() and (char*) etc~~
	</syntaxhighlight>		</syntaxhighlight>

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

UberFoX at 19:14, 18 September 2015

2015-09-18T19:14:52Z

← Older revision		Revision as of 19:14, 18 September 2015
Line 1:		Line 1:
	<pre>		<pre>
−	StrNew( <char>, <length>~~, <flag>~~	+	StrNew( <char>, <length> )
	</pre>		</pre>

	=== Description ===		=== Description ===

−	Create a new string of a given length filled with a given char ~~(or optionally return it as a CharPtr rather than a new string)~~.	+	Create a new string of a given length filled with a given char.

	=== Parameters ===		=== Parameters ===
Line 11:		Line 11:
	==== char ====		==== char ====

		+	What char should populate the new string.

	==== length ====		==== length ====

−	~~==== flag ====~~	+	How big the new string should be.
−	~~Optional; Choose if you want to return as a normal~~ string ~~or a CharPtr~~	+
−		+
−	~~true -- Return as CharPtr~~	+
−		+
−	~~false -- Return as string~~	+
−		+
−	~~Default: false~~	+

	=== Return Value ===		=== Return Value ===

−	Success: ~~If the flag is TRUE then return will be a CharPtr. If the flag is FALSE then return will be a normal~~ string	+	Success: The new string.

	Failure: null		Failure: null
Line 31:		Line 25:
	=== Remarks ===		=== Remarks ===

−	If the FLAG is true memory will be allocated and the pointer returned to the memory you must use Free() command to reclaim that memory after you are finished with it, You can of course convert it to a string using (string) cast then immediately free the CharPtr.	+	None.
−		+
−	One benefit of this function is it will create the String/CharPtr in the correct memory size and type that Sputnik uses for Strings (should be in UTF8 format so 2 bytes per char with a zero terminator 2 bytes long).	+

	=== Example ===		=== Example ===
Line 49:		Line 41:
	// The purpose of this function is just to make it more		// The purpose of this function is just to make it more
	// simple to create a string for use in Fixed() and (char*) etc		// simple to create a string for use in Fixed() and (char*) etc
−	~~</syntaxhighlight>~~
−
−	~~Example of TRUE flag and converting the return to string once done with it~~
−	~~<syntaxhighlight lang="sputnik">~~
−	~~// Create pointer to a newly created string containing '5' chars of 'A'~~
−	~~// the return will be as a CharPtr rather than a normal string~~
−	~~$PTR = StrNew('A', 5, true);~~
−	*$PTR = 'T'; // Set first character to T
−	~~$PTR[1] = 'B'; // Set second character to B~~
−	~~$STR = (string)$PTR; // Convert the CharPtr to a string~~
−	~~free($PTR); // Free the CharPtr as it is no longer needed~~
−	~~printr( $STR ); // Prints TBAAA~~
	</syntaxhighlight>		</syntaxhighlight>

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

UberFoX at 13:50, 18 September 2015

2015-09-18T13:50:15Z

← Older revision		Revision as of 13:50, 18 September 2015
Line 5:		Line 5:
	=== Description ===		=== Description ===

−	Create a new string of a given length filled with a given char (or optionally return it as a CharPtr rather than a new string.	+	Create a new string of a given length filled with a given char (or optionally return it as a CharPtr rather than a new string).

	=== Parameters ===		=== Parameters ===

UberFoX: /* Description */

2015-09-18T13:49:26Z

Description

← Older revision		Revision as of 13:49, 18 September 2015
Line 5:		Line 5:
	=== Description ===		=== Description ===

−	Create a new string of a given length filled with a given char (or optionally return it as a CharPtr rather than a new string).	+	Create a new string of a given length filled with a given char (or optionally return it as a CharPtr rather than a new string.

	=== Parameters ===		=== Parameters ===

UberFoX: 1 revision

2015-06-14T12:37:32Z

1 revision

← Older revision

Revision as of 12:37, 14 June 2015

UberFoX: 1 revision

2014-08-11T21:41:03Z

1 revision

← Older revision

Revision as of 21:41, 11 August 2014

UberFoX: /* Remarks */

2013-09-12T08:28:43Z

Remarks

← Older revision		Revision as of 08:28, 12 September 2013
Line 33:		Line 33:
	If the FLAG is true memory will be allocated and the pointer returned to the memory you must use Free() command to reclaim that memory after you are finished with it, You can of course convert it to a string using (string) cast then immediately free the CharPtr.		If the FLAG is true memory will be allocated and the pointer returned to the memory you must use Free() command to reclaim that memory after you are finished with it, You can of course convert it to a string using (string) cast then immediately free the CharPtr.

−	One benefit of this function is it will create the String/CharPtr in the correct memory size and type that Sputnik uses for Strings (should be in UTF8 format so 2 bytes per char).	+	One benefit of this function is it will create the String/CharPtr in the correct memory size and type that Sputnik uses for Strings (should be in UTF8 format so 2 bytes per char with a zero terminator 2 bytes long).

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

UberFoX: /* Remarks */

2013-09-12T08:28:30Z

Remarks

← Older revision		Revision as of 08:28, 12 September 2013
Line 32:		Line 32:

	If the FLAG is true memory will be allocated and the pointer returned to the memory you must use Free() command to reclaim that memory after you are finished with it, You can of course convert it to a string using (string) cast then immediately free the CharPtr.		If the FLAG is true memory will be allocated and the pointer returned to the memory you must use Free() command to reclaim that memory after you are finished with it, You can of course convert it to a string using (string) cast then immediately free the CharPtr.
		+
		+	One benefit of this function is it will create the String/CharPtr in the correct memory size and type that Sputnik uses for Strings (should be in UTF8 format so 2 bytes per char).

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

UberFoX: Created page with "

 StrNew( , ,

=== Description === Create a new string of a given length filled with a given char (or optionally return it as a CharPtr rather th..."

2013-09-12T08:27:36Z

Created page with "<pre> StrNew( <char>, <length>, <flag> </pre> === Description === Create a new string of a given length filled with a given char (or optionally return it as a CharPtr rather th..."

New page

<pre>
StrNew( <char>, <length>, <flag>
</pre>

=== Description ===

Create a new string of a given length filled with a given char (or optionally return it as a CharPtr rather than a new string).

=== Parameters ===

==== char ====

==== length ====

==== flag ====
Optional; Choose if you want to return as a normal string or a CharPtr

true -- Return as CharPtr

false -- Return as string

Default: false

=== Return Value ===

Success: If the flag is TRUE then return will be a CharPtr. If the flag is FALSE then return will be a normal string

Failure: null

=== Remarks ===

If the FLAG is true memory will be allocated and the pointer returned to the memory you must use Free() command to reclaim that memory after you are finished with it, You can of course convert it to a string using (string) cast then immediately free the CharPtr.

=== Example ===

Normal string
<syntaxhighlight lang="sputnik">
$Str = StrNew('T', 15);
$Str[0] = 'A'; // Set first char to A
$Str[1] = 'A'; // Set second char to B
echo $Str; // Prints: ABTTTTTTTTTTTTT
// Of course you could just make the string like
// $Str = "ABTTTTTTTTTTTTT";
// OR
// $Str = "AB" . ('T' x 13);
// The purpose of this function is just to make it more
// simple to create a string for use in Fixed() and (char*) etc
</syntaxhighlight>

Example of TRUE flag and converting the return to string once done with it
<syntaxhighlight lang="sputnik">
// Create pointer to a newly created string containing '5' chars of 'A'
// the return will be as a CharPtr rather than a normal string
$PTR = StrNew('A', 5, true);
*$PTR = 'T'; // Set first character to T
$PTR[1] = 'B'; // Set second character to B
$STR = (string)$PTR; // Convert the CharPtr to a string
free($PTR); // Free the CharPtr as it is no longer needed
printr( $STR ); // Prints TBAAA
</syntaxhighlight>

[[Category:Core Function]]