From 3f9be98561f3afa99cfe820f7aee7e8fe7ba046f Mon Sep 17 00:00:00 2001
From: perry.werneck@gmail.com <perry.werneck@gmail.com@d25448e0-c022-0410-b998-a785f7053de0>
Date: Wed, 15 Feb 2012 13:58:17 +0000
Subject: [PATCH] Documentando nova API

---
 latest/src/include/lib3270.h     | 51 ++++++++++++++++++++++++++++++++++++++++++++++-----
 latest/src/include/lib3270/api.h | 43 +++++++++++++++++++------------------------
 latest/src/lib/screen.c          |  2 +-
 3 files changed, 66 insertions(+), 30 deletions(-)

diff --git a/latest/src/include/lib3270.h b/latest/src/include/lib3270.h
index e6aaa2f..2c13578 100644
--- a/latest/src/include/lib3270.h
+++ b/latest/src/include/lib3270.h
@@ -98,11 +98,15 @@
 
 	} LIB3270_TOGGLE;
 
+	/**
+	 * OIA Status indicators.
+	 *
+	 */
 	typedef enum _lib3270_flag
 	{
-		LIB3270_FLAG_BOXSOLID,
-		LIB3270_FLAG_UNDERA,
-		LIB3270_FLAG_SECURE,
+		LIB3270_FLAG_BOXSOLID,	/**< System available */
+		LIB3270_FLAG_UNDERA,	/**< Control Unit STATUS */
+		LIB3270_FLAG_SECURE,	/**< Security status */
 		LIB3270_FLAG_TYPEAHEAD,
 		LIB3270_FLAG_PRINTER,
 		LIB3270_FLAG_REVERSE,
@@ -114,6 +118,34 @@
 
 
 	/**
+	 * 3270 program messages.
+	 *
+	 */
+	typedef enum _LIB3270_MESSAGE
+	{
+		LIB3270_MESSAGE_NONE,				/**< No message */
+		LIB3270_MESSAGE_SYSWAIT,
+		LIB3270_MESSAGE_TWAIT,
+		LIB3270_MESSAGE_CONNECTED,
+		LIB3270_MESSAGE_DISCONNECTED,		/**< Disconnected from host */
+		LIB3270_MESSAGE_AWAITING_FIRST,
+		LIB3270_MESSAGE_MINUS,
+		LIB3270_MESSAGE_PROTECTED,
+		LIB3270_MESSAGE_NUMERIC,
+		LIB3270_MESSAGE_OVERFLOW,
+		LIB3270_MESSAGE_INHIBIT,
+		LIB3270_MESSAGE_KYBDLOCK,
+
+		LIB3270_MESSAGE_X,
+		LIB3270_MESSAGE_RESOLVING,			/**< Resolving hostname (running DNS query) */
+		LIB3270_MESSAGE_CONNECTING,			/**< Connecting to host */
+
+		LIB3270_MESSAGE_USER
+
+	} LIB3270_MESSAGE;
+
+
+	/**
 	 * Cursor modes.
 	 *
 	 * Cursor modes set by library; an application can us it
@@ -214,7 +246,6 @@
 	 */
 	LIB3270_EXPORT int lib3270_connect(H3270 *h,const char *n, int wait);
 
-
 	/**
 	 * Disconnect from host.
 	 *
@@ -340,7 +371,17 @@
 	int LIB3270_EXPORT lib3270_register_io_handlers(const struct lib3270_io_callbacks *cbk);
 
 
-	LIB3270_EXPORT LIB3270_STATUS	  lib3270_get_oia_status(H3270 *h);
+	/**
+	 * Get program message.
+	 *
+	 * @see LIB3270_MESSAGE
+	 *
+	 * @param h	Session handle.
+	 *
+	 * @return Latest program message.
+	 *
+	 */
+	LIB3270_EXPORT LIB3270_MESSAGE	  lib3270_get_program_message(H3270 *h);
 
 	/**
 	 * Get connected LU name
diff --git a/latest/src/include/lib3270/api.h b/latest/src/include/lib3270/api.h
index 17df3ee..1df2b24 100644
--- a/latest/src/include/lib3270/api.h
+++ b/latest/src/include/lib3270/api.h
@@ -158,28 +158,23 @@
 		#define CONNECTED_SSCP	LIB3270_CONNECTED_SSCP
 		#define CONNECTED_TN3270E	LIB3270_CONNECTED_TN3270E
 
-		typedef enum _LIB3270_STATUS
-		{
-			LIB3270_STATUS_BLANK,
-			LIB3270_STATUS_SYSWAIT,
-			LIB3270_STATUS_TWAIT,
-			LIB3270_STATUS_CONNECTED,
-			LIB3270_STATUS_DISCONNECTED,
-			LIB3270_STATUS_AWAITING_FIRST,
-			LIB3270_STATUS_MINUS,
-			LIB3270_STATUS_PROTECTED,
-			LIB3270_STATUS_NUMERIC,
-			LIB3270_STATUS_OVERFLOW,
-			LIB3270_STATUS_INHIBIT,
-			LIB3270_STATUS_KYBDLOCK,
-
-			LIB3270_STATUS_X,
-			LIB3270_STATUS_RESOLVING,
-			LIB3270_STATUS_CONNECTING,
-
-			LIB3270_STATUS_USER
-
-		} LIB3270_STATUS;
+		#define LIB3270_STATUS					LIB3270_MESSAGE
+		#define LIB3270_STATUS_BLANK			LIB3270_MESSAGE_NONE
+		#define LIB3270_STATUS_SYSWAIT			LIB3270_MESSAGE_SYSWAIT
+		#define LIB3270_STATUS_TWAIT			LIB3270_MESSAGE_TWAIT
+		#define LIB3270_STATUS_CONNECTED		LIB3270_MESSAGE_CONNECTED
+		#define LIB3270_STATUS_DISCONNECTED		LIB3270_MESSAGE_DISCONNECTED
+		#define LIB3270_STATUS_AWAITING_FIRST	LIB3270_MESSAGE_AWAITING_FIRST
+		#define LIB3270_STATUS_MINUS			LIB3270_MESSAGE_MINUS
+		#define LIB3270_STATUS_PROTECTED		LIB3270_MESSAGE_PROTECTED
+		#define LIB3270_STATUS_NUMERIC			LIB3270_MESSAGE_NUMERIC
+		#define LIB3270_STATUS_OVERFLOW			LIB3270_MESSAGE_OVERFLOW
+		#define LIB3270_STATUS_INHIBIT			LIB3270_MESSAGE_INHIBIT
+		#define LIB3270_STATUS_KYBDLOCK			LIB3270_MESSAGE_KYBDLOCK
+		#define LIB3270_STATUS_X				LIB3270_MESSAGE_X
+		#define LIB3270_STATUS_RESOLVING		LIB3270_MESSAGE_RESOLVING
+		#define LIB3270_STATUS_CONNECTING		LIB3270_MESSAGE_CONNECTING
+		#define LIB3270_STATUS_USER				LIB3270_MESSAGE_USER
 
 		#define OIA_FLAG_BOXSOLID	LIB3270_FLAG_BOXSOLID
 		#define OIA_FLAG_UNDERA		LIB3270_FLAG_UNDERA
@@ -224,7 +219,7 @@
 			char	       		* qualified_host;
 			char	 			  auto_reconnect_inprogress;
 
-			LIB3270_STATUS		  oia_status;
+			LIB3270_MESSAGE		  oia_status;
 
 			unsigned char 		  oia_flag[LIB3270_FLAG_COUNT];
 
@@ -579,7 +574,7 @@
 		LIB3270_EXPORT void 		  popup_system_error(const char *title, const char *message, const char *system);
 		LIB3270_EXPORT void 		  popup_a_sockerr(char *fmt, ...);
 
-		#define query_3270_terminal_status(void) lib3270_get_oia_status(NULL)
+		#define query_3270_terminal_status(void) lib3270_get_program_message(NULL)
 
 		LIB3270_EXPORT int			  set_3270_model(H3270 *session, int model);
 		LIB3270_EXPORT int			  get_3270_model(H3270 *session);
diff --git a/latest/src/lib/screen.c b/latest/src/lib/screen.c
index c92bc5c..abfd2df 100644
--- a/latest/src/lib/screen.c
+++ b/latest/src/lib/screen.c
@@ -584,7 +584,7 @@ void status_reset(H3270 *session)
  *
  * @see LIB3270_STATUS
  */
-LIB3270_EXPORT LIB3270_STATUS lib3270_get_oia_status(H3270 *session)
+LIB3270_EXPORT LIB3270_STATUS lib3270_get_program_message(H3270 *session)
 {
 	CHECK_SESSION_HANDLE(session);
 	return session->oia_status;
--
libgit2 0.21.2