The intrinsic functions described in this chapter are available in article mode and allow you to manipulate the article window.
Integer _is_article_visible ()
This function returns information about whether or not the article associated with the current header is visible in a window and whether or not it is attached to the current header. Specifically, it returns a bitmapped value:
0 : if the article window is hidden and not associated with the
current header.
1 : if the article window is showing but the current header
does not refer to the article.
2 : if the article window is hidden but attached to the current
header.
3 : if the article window is showing and contains the current
header article.
If one only want to know whether or not there is an article visible in the window, then use
_is_article_visible () & 1
_is_article_visible () & 2
_is_article_visible, is_article_window_zoomed, call
String_Type article_as_string ()
This function will return the entire contents of the current article as a string. If no article has been dowloaded, the empty string will be returned. The current article may not be the one associated with the currently selected header.
raw_article_as_string, replace_article, is_article_visible
String_Type article_cline_as_string ()
Returns the current line of the article (i.e. the first one that is displayed in the article pager) as a string. If no article has been downloaded, the empty string will be returned.
article_as_string, article_cline_number
Integer article_cline_number ()
Returns the number of the line that is currently displayed at the top of the article pager. Counting starts at 1 and ignores hidden lines.
article_cline_as_string, article_count_lines, article_goto_line
Integer article_count_lines ()
This function returns the total number of visible lines in the article
pager. For example, you could use it with article_goto_line to
jump to the last line in the pager:
define article_bob ()
{
() = article_goto_line (article_count_lines ());
}
Integer article_goto_line (Integer linenum)
Makes the article pager jump to line number linenum (i.e., puts
this line at the top of the pager). As in article_cline_number,
counting starts at 1 and ignores hidden lines. If you specify 0 or a
negative number as the argument, no action is taken and the function
returns zero. Otherwise, the new line number is returned. If the article
has less than linenum lines, the function goes to the last line.
article_line_down, article_line_up
Integer article_line_down (Integer num)
Scrolls the article down num lines. Returns the number of lines
that were actually scrolled.
If no article is in the pager, scrolling down first downloads an article.
article_goto_line, article_line_up
Integer article_line_up (Integer num)
Scrolls the article up num lines and returns the number of lines
that were actually scrolled.
article_goto_line, article_line_down
Integer bsearch_article (String_Type pat)
This function works like search_article, but does a backward search.
search_article
Integer get_article_window_size ()
get_article_window_size may be used to determine the height of the
article window.
set_article_window_size
Integer get_body_status ()
When reading from an slrnpull spool in "true offline" mode, the body that belongs to an article header might not yet be on disk. This function returns one of the following values:
-1 : currently, no header is selected
0 : the body of the current article is present
1 : the body of the article is missing
2 : the body of the article is missing, but requested for download
request_body
Integer get_next_art_pgdn_action ()
This function may be used to get information about what action slrn will take when an attempt is made to go to the next page of the current article, e.g., by pressing the space key. It returns one of the following integers:
-1 Not in article mode
0 Next page of the article will be displayed
1 The next unread article will be displayed
2 The newsreader will go to the next newsgroup
Integer is_article_visible ()
This function returns information about whether or not the article associated with the current header is visible in a window. Specifically, it returns:
0 : if the article window is hidden
1 : if the article window is showing but the current header
does not refer to the article
3 : if the article window contains the current header article
For some purposes, it may be more useful to the the
_is_article_visible function which may be slightly more
useful. In fact, is_article_visible may be written in terms
of _is_article_visible as
define is_article_visible ()
{
variable status = _is_article_visible ();
!if (status & 1) return 0;
return status;
}
_is_article_visible, is_article_window_zoomed, call
Integer is_article_window_zoomed ()
This function returns 1 if the article window is zoomed, or 0 otherwise.
is_article_visible, call
Void pipe_article (String cmd)
This function may be used to pipe the current article to the command
given by the cmd argument. If the article window is hidden, it
downloads the article associated with the currently selected header.
read_mini
String_Type raw_article_as_string ()
This function works exactly like article_as_string, except that it
returns the article as it was sent by the server, not as it has been
prepared for display (e.g. before MIME decoding and character recoding).
The raw article is no longer available after you called
replace_article. In this case, the output is the same as the one of
article_as_string.
Integer re_bsearch_article (String_Type pat)
This function works like re_search_article, but does a backward search.
re_search_article
Integer re_search_article (String_Type pat)
This function searches forward in the current article for a string
matching the regular expression given by the parameter pat. It
returns 0 if no matching line is found. Otherwise, it returns 1 and the
matching line will be left on the stack as a string.
re_search_article_first
search_article
Integer re_search_article_first (String_Type pat)
Works like re_search_article, but finds the first match in the article (searching from the beginning instead of forward from the current point).
re_search_article
replace_article (String_Type string)
The replace_article may be used to replace the text of
the currently displayed article with an arbitrary string.
The following code fragment causes the text of an article to be replaced by its lowercase equivalent:
replace_article (strlow (article_as_string ()));
article_as_string, is_article_visible
request_body (Integer mode)
If an article does not yet have a body, you can request it for download
using this function. Setting mode to 1 requests the body, setting it
to 0 un-requests it.
get_body_status
Integer save_current_article (String filename)
This function saves the currently selected article to a file specified by
filename. If the article window is hidden, it downloads the the
article associated with the currently selected header. It returns 0 upon
success; upon failure, it returns -1 and sets an slang error condition.
This function always creates a new file, overwriting existing ones.
Integer search_article (String str)
This function searches forward in the current article (if none is
visible, in the one associated with the currently selected header) for
the string given by the parameter str. It returns 0 if no matching
line is found. Otherwise, it returns 1 and the matching line will be
left on the stack as a string.
re_search_article
search_article_first
Integer search_article_first (String_Type pat)
Works like search_article, but finds the first match in the article (searching from the beginning instead of forward from the current point). This means you can find all matches in the article by calling search_article_first once and subsequently using search_article.
search_article
Void set_article_window_size (Integer nrows)
The set_article_window_size may be used to set the height of the
article window. The variable SCREEN_HEIGHT may be used to
facilitate this.
get_article_window_size