Document mode prefixes

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@4999 e03df62e-2008-0410-955e-edbf42e46eb7

2 files changed, 79 insertions, 6 deletions

diff --git a/include/channels.h b/include/channels.h
index 489c8b0e8..132e3ba04 100644
--- a/include/channels.h
+++ b/include/channels.h
@@ -144,8 +144,16 @@ class ucrec : public classbase
 
 class InspIRCd;
 
+/** A stored prefix and its rank
+ */
 typedef std::pair<char, unsigned int> prefixtype;
+
+/** A list of prefixes set on a user in a channel
+ */
 typedef std::vector<prefixtype> pfxcontainer;
+
+/** A list of users with zero or more prefixes set on them
+ */
 typedef std::map<userrec*, std::vector<prefixtype> > prefixlist;
 
 /** Holds all relevent information for a channel.
@@ -467,14 +475,48 @@ class chanrec : public Extensible
 	 */
 	int GetStatusFlags(userrec *user);
 
-	/** Get a users status on this channel in a string
+	/** Get a users prefix on this channel in a string.
+	 * @param The user to look up
+	 * @return A character array containing the prefix string.
+	 * Unlike GetStatus and GetStatusFlags which will only return the
+	 * core specified modes @, % and + (op, halfop and voice), GetPrefixChar
+	 * will also return module-defined prefixes. If the user has to prefix,
+	 * an empty but non-null string is returned. If the user has multiple
+	 * prefixes, the highest is returned. If you do not recognise the prefix
+	 * character you can get, you can deal with it in a 'proprtional' manner
+	 * compared to known prefixes, using GetPrefixValue().
+	 */
+	const char* GetPrefixChar(userrec *user);
+
+	/** Get the value of a users prefix on this channel.
 	 * @param The user to look up
-	 * @return A character array containing the string "@", "%", "+" or ""
+	 * @return The module or core-defined value of the users prefix.
+	 * The values for op, halfop and voice status are constants in
+	 * mode.h, and are OP_VALUE, HALFOP_VALUE, and VOICE_VALUE respectively.
+	 * If the value you are given does not match one of these three, it is
+	 * a module-defined mode, and it should be compared in proportion to
+	 * these three constants. For example a value greater than OP_VALUE
+	 * is a prefix of greater 'worth' than ops, and a value less than
+	 * VOICE_VALUE is of lesser 'worth' than a voice.
+	 */
+	unsigned int GetPrefixValue(userrec* user);
+
+	/** This method removes all prefix characters from a user.
+	 * It will not inform the user or the channel of the removal of prefixes,
+	 * and should be used when the user parts or quits.
+	 * @param The user to remove all prefixes from
 	 */
-	const char* GetStatusChar(userrec *user);
-
 	void RemoveAllPrefixes(userrec* user);
 
+	/** Add a prefix character to a user.
+	 * Only the core should call this method, usually  from
+	 * within the mode parser or when the first user joins
+	 * the channel (to grant ops to them)
+	 * @param The user to associate the privilage with
+	 * @param prefix The prefix character to associate
+	 * @param prefix_rank The rank (value) of this prefix character
+	 * @param adding True if adding the prefix, false when removing
+	 */
 	void SetPrefix(userrec* user, char prefix, unsigned int prefix_rank, bool adding);
 
 	/** Destructor for chanrec
diff --git a/include/mode.h b/include/mode.h
index 10b21a6b7..b63c7f3b2 100644
--- a/include/mode.h
+++ b/include/mode.h
@@ -60,6 +60,14 @@ enum ModeMasks
 	MASK_CHANNEL = 0	/* A channel mode */
 };
 
+/**
+ * These fixed values can be used to proportionally compare module-defined prefixes to known values.
+ * For example, if your module queries a chanrec, and is told that user 'joebloggs' has the prefix
+ * '$', and you dont know what $ means, then you can compare it to these three values to determine
+ * its worth against them. For example if '$' had a value of 15000, you would know it is of higher
+ * status than voice, but lower status than halfop.
+ * No two modes should have equal prefix values.
+ */
 enum PrefixModeValue
 {
 	VOICE_VALUE	=	10000,
@@ -141,6 +149,11 @@ class ModeHandler : public Extensible
 	 * @param listmode Set to true if your mode is a listmode, e.g. it will respond to MODE #channel +modechar with a list of items
 	 * @param ModeType Set this to MODETYPE_USER for a usermode, or MODETYPE_CHANNEL for a channelmode.
 	 * @param operonly Set this to true if only opers should be allowed to set or unset the mode.
+	 * @param mprefix For listmodes where parameters are NICKNAMES which are on the channel (for example, +ohv), you may define a prefix.
+	 * When you define a prefix, it can be returned in NAMES, WHO etc if it has the highest value (as returned by GetPrefixRank())
+	 * In the core, the only modes to implement prefixes are +ovh (ops, voice, halfop) which define the prefix characters @, % and +
+	 * and the rank values OP_VALUE, HALFOP_VALUE and VOICE_VALUE respectively. Any prefixes you define should have unique values proportional
+	 * to these three defaults or proportional to another mode in a module you depend on. See src/cmode_o.cpp as an example.
 	 */
 	ModeHandler(InspIRCd* Instance, char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly, char mprefix = 0);
 	/**
@@ -152,13 +165,17 @@ class ModeHandler : public Extensible
 	 */
 	bool IsListMode();
 	/**
-	 * Mode prefix or 0
+	 * Mode prefix or 0. If this is defined, you should
+	 * also implement GetPrefixRank() to return an integer
+	 * value for this mode prefix.
 	 */
 	char GetPrefix();
 	/**
 	 * Get the 'value' of this modes prefix.
 	 * determines which to display when there are multiple.
-	 * The mode with the highest value is ranked first.
+	 * The mode with the highest value is ranked first. See the
+	 * PrefixModeValue enum and chanrec::GetPrefixValue() for
+	 * more information.
 	 */
 	virtual unsigned int GetPrefixRank();
 	/**
@@ -409,12 +426,26 @@ class ModeParser : public classbase
 	 */
 	ModeHandler* FindMode(unsigned const char modeletter, ModeType mt);
 
+	/**
+	 * Returns a list of mode characters which are usermodes.
+	 * This is used in the 004 numeric when users connect.
+	 */
 	std::string UserModeList();
 
+	/**
+	 * Returns a list of channel mode characters which are listmodes.
+	 * This is used in the 004 numeric when users connect.
+	 */
 	std::string ChannelModeList();
 
+	/**
+	 * Returns a list of channel mode characters which take parameters.
+	 * This is used in the 004 numeric when users connect.
+	 */
 	std::string ParaModeList();
 
+	/** Used to parse the CHANMODES= parameter of a 005 numeric.
+	 */
 	bool InsertMode(std::string &output, const char* mode, unsigned short section);
 };