Source:NetHack 3.4.3/src/objnam.c - Revision history

Umbire the Phantom: mixedsyntaxhighlight

2024-12-09T23:15:26Z

mixedsyntaxhighlight

Furey: Fix instructions for linking to a particular line. Current instructions incorrectly link to a different version of NetHack.

2024-06-26T00:19:05Z

Fix instructions for linking to a particular line. Current instructions incorrectly link to a different version of NetHack.

Furey: /* obj_typename */ Fix a redlink for gem/glass.

2024-06-18T17:23:55Z

‎obj_typename: Fix a redlink for gem/glass.

Furey: Delinkify "terminal". Fixes a redlink.

2024-06-18T15:26:39Z

Delinkify "terminal". Fixes a redlink.

Furey: Delinkify "plural". It's already in the lede with no link, so we don't need one later. Fixes a redlink.

2024-06-17T07:06:01Z

Delinkify "plural". It's already in the lede with no link, so we don't need one later. Fixes a redlink.

Furey: Delinkify "counts". Fixes a redlink. This is source code annotation.

2024-06-16T20:50:01Z

Delinkify "counts". Fixes a redlink. This is source code annotation.

Furey: /* strprepend */ delinkify strncpy. Fixes a redlink.

2024-06-16T19:45:40Z

‎strprepend: delinkify strncpy. Fixes a redlink.

Furey: /* Top of file */ delinkify "string" (as in C string). This is in the commentary. Fixes a redlink.

2024-06-16T19:43:07Z

‎Top of file: delinkify "string" (as in C string). This is in the commentary. Fixes a redlink.

Umbire the Phantom: snapback

2023-10-29T16:07:41Z

snapback

Umbire the Phantom: pothole

2023-10-29T15:56:38Z

pothole

← Older revision		Revision as of 23:15, 9 December 2024
Line 1:		Line 1:
−	~~__MIXEDSYNTAXHIGHLIGHT__~~
	Below is the full text to src/objnam.c from NetHack 3.4.3. To link to a particular line, write [[Source:NetHack 3.4.3/src/objnam.c#line123]], for example.		Below is the full text to src/objnam.c from NetHack 3.4.3. To link to a particular line, write [[Source:NetHack 3.4.3/src/objnam.c#line123]], for example.

@@ Line 1: / Line 1: @@
 __MIXEDSYNTAXHIGHLIGHT__
-Below is the full text to src/objnam.c from NetHack 3.4.3. To link to a particular line, write [[objnam.c#line123|<nowiki>[[</nowiki>objnam.c#line123<nowiki>]]</nowiki>]], for example.
+Below is the full text to src/objnam.c from NetHack 3.4.3. To link to a particular line, write [[Source:NetHack 3.4.3/src/objnam.c#line123]], for example.
 The job of this particular [[source code]] file is to give the name of an [[object]] as a string. A read will reveal much about how NetHack discloses the identity of objects and how it uses the fields from the struct defined in [[obj.h]]. This file also handles putting articles (a, an, the) in front of names, making names plural, and interpreting [[wish]]es.

@@ Line 326: / Line 326: @@
   <span id="line145">145.  						" stone" : " gem");</span>
-The code appends the word "stone" or "gem" to all unidentified gems (belonging to GEM_CLASS). The effect here is that obvious minerals obtain the word "stone", yielding a "[[gray stone]]", while all other objects obtain the word "gem" (for example, "violet [[gem]]"), thus making it ambiguous whether the unidentified thing is a valuable stone or a [[worthless piece of glass]].
+The code appends the word "stone" or "gem" to all unidentified gems (belonging to GEM_CLASS). The effect here is that obvious minerals obtain the word "stone", yielding a "[[gray stone]]", while all other objects obtain the word "gem" (for example, "violet [[gem]]"), thus making it ambiguous whether the unidentified thing is a valuable [[gem]] or a worthless piece of glass.
   <span id="line146">146.  			if(un)</span>

@@ Line 160: / Line 160: @@
 * If you increase NUMOBUF and BUFSZ to very large then you start wasting space. (So use nextobuf for NetHack object naming, not for large databases.)
-This nextobuf function works well because objects in NetHack can only have names that are so long (for they should fit in the inventory screen on an 80x24 [[terminal]]), and the code is relatively linear and does not loop through the creation of many buffers.
+This nextobuf function works well because objects in NetHack can only have names that are so long (for they should fit in the inventory screen on an 80x24 terminal), and the code is relatively linear and does not loop through the creation of many buffers.
 Yet many programmers would have just dynamically allocated buffers instead of using a solution such as this.

@@ Line 170: / Line 170: @@
   <span id="line93">93.   {</span>
-The goal of the <code>obj_typename</code> function is to return type names such as "amethyst stone (violet)", "wand called cancellation (balsa)", "ring of warning (topaz)". The name does not include information not known to the player; an unidentified scroll or spellbook could be "scroll (THARR)" or "spellbook (wrinkled)". The information is only about a particular ''type'' of object, and never includes details about a particular object such as counts, [[BUC]] statuses, [[enchantment]]s, or [[charge]]s. Thus the type is singular, never [[plural]].
+The goal of the <code>obj_typename</code> function is to return type names such as "amethyst stone (violet)", "wand called cancellation (balsa)", "ring of warning (topaz)". The name does not include information not known to the player; an unidentified scroll or spellbook could be "scroll (THARR)" or "spellbook (wrinkled)". The information is only about a particular ''type'' of object, and never includes details about a particular object such as counts, [[BUC]] statuses, [[enchantment]]s, or [[charge]]s. Thus the type is singular, never plural.
 For example, a call to <code>otyp(SILVER_DAGGER)</code> returns only "silver dagger". A call to <code>otyp(ELVEN_DAGGER)</code> apparently returns either "elven dagger" or "runed dagger", but not "elven dagger (runed dagger)", because descriptions are only appended for certain classes of objects.

@@ Line 113: / Line 113: @@
   <span id="line72">72.   	(void) strncpy(s, pref, i);	/* do not copy trailing 0 */</span>
-Exactly i characters are copied from the prefix to where the pointer s is; this correctly prepends the prefix to the string. Note that [[strncpy]] terminates s with the trailing 0 if and only if pref has less than i characters; this is often the source of bugs (and is why *[[BSD]] has strlcpy). The call for strprepend is a rare case of strncpy is ''used correctly but does not terminate the string''. The comment "/* do not copy trailing 0 */" is a reminder that this use of strncpy is correct.
+Exactly i characters are copied from the prefix to where the pointer s is; this correctly prepends the prefix to the string. Note that strncpy terminates s with the trailing 0 if and only if pref has less than i characters; this is often the source of bugs (and is why *[[BSD]] has strlcpy). The call for strprepend is a rare case of strncpy is ''used correctly but does not terminate the string''. The comment "/* do not copy trailing 0 */" is a reminder that this use of strncpy is correct.
   <span id="line73">73.   	return(s);</span>

@@ Line 20: / Line 20: @@
   <span id="line11">11.   </span>
-NetHack employs two unusual ways to manipulate [[string]]s in C. It will put some object names (like "corpse") PREFIX characters into a buffer so that it can add prefixes (like "an uncursed greased partly eaten guardian naga hatchling") with the [[#strprepend|strprepend]] function. Meanwhile, it statically allocates NUMOBUF buffers of SCHAR_LIM characters each and makes those buffers available to the [[#nextobuf|nextobuf]] function.
+NetHack employs two unusual ways to manipulate strings in C. It will put some object names (like "corpse") PREFIX characters into a buffer so that it can add prefixes (like "an uncursed greased partly eaten guardian naga hatchling") with the [[#strprepend|strprepend]] function. Meanwhile, it statically allocates NUMOBUF buffers of SCHAR_LIM characters each and makes those buffers available to the [[#nextobuf|nextobuf]] function.
   <span id="line12">12.   STATIC_DCL char *FDECL([[#strprepend|strprepend]],(char *,const char *));</span>

@@ Line 229: / Line 229: @@
 |-
 || <code>case WAND_CLASS</code>
-|| for [[wand]]s [[forward slash|/]]
+|| for [[wand]]s [[slash|/]]
 || [[#line113]]
 |-