Wewnętrzne funkcje slrn 
> Instalacja i konfiguracja > Podręcznik > FAQ > Pozostała dokumentacja

2. Funkcje dostępne w trybie artykułów

Funkcje wbudowane opisane w tym rozdziale są dostępne w trybie artykułów; ich przeznaczeniem jest manipulowanie oknem artykułów.

2.1 _is_article_visible

Składnia

Integer _is_article_visible ()

Opis

Funkcja ta zwraca informację o tym, czy artykuł nagłówkiem jest widoczny w oknie, i czy jest skojarzony z bieżącym nagłówkiem. Informacja zwracana ma postać pola bitowego:

      0  : jeśli okno artykułów jest ukryte i nie skojarzone z bieżącym
             nagłówkiem,
      1  : jeśli okno artykułów jest widoczne, ale bieżący nagłówek nie
             odnosi się do pokazywanego artykułu,
      2  : jeśli okno artykułów jest ukryte, ale skojarzone z bieżącym 
             nagłówkiem,
      3  : jeśli okno artykułów jest widoczne i zawiera artykuł skojarzony z
             bieżącym nagłówkiem.

Przykład

Jeśli potrzebujesz jedynie informacji o tym, czy okno artykułu jest widoczne, użyj:

      _is_article_visible () & 1

W celu określenia, czy zawartość okna artykułu jest skojarzona z bieżącym nagłówkiem niezależnie od tego, czy jest ono widoczne, użyj:

      _is_article_visible () & 2

Zobacz również

_is_article_visible, is_article_window_zoomed, call

2.2 article_as_string

Składnia

String_Type article_as_string ()

Opis

Funkcja ta zwraca całą zawartość bieżącego artykułu jako zmienną napisową. Jeśli żaden artykuł nie został ściągnięty, zwrócony zostanie pusty napis. Bieżący artykuł nie musi być skojarzony z bieżącym nagłówkiem.

Zobacz również

replace_article, is_article_visible

2.3 bsearch_article

Składnia

Integer bsearch_article (String_Type pat)

Opis

Funkcja działa tak samo jak search_article, ale szuka wstecz.

Zobacz również

search_article

2.4 get_article_window_size

Składnia

Integer get_article_window_size ()

Opis

Funkcja ta zwraca wysokość okna artykułów.

Zobacz również

set_article_window_size

2.5 get_next_art_pgdn_action

Składnia

Integer get_next_art_pgdn_action ()

Opis

Funkcja ta pozwala na uzyskanie informacji o tym, jaka akcja zostanie podjęta przez slrn w odpowiedzi na próbę przesunięcia artykułu o stronę w dół, np. po naciśnięciu klawisza Spacja. Funkcja zwraca jedną z poniższych liczb całkowitych:

       -1  Błąd: tryb artykułów nie jest trybem bieżącym,
        0  Zostanie wyświetlona następna strona artykułu,
        1  Zostanie wyświetlony następny artykuł,
        2  Czytnik przejdzie do następnej grupy.

2.6 is_article_visible

Składnia

Integer is_article_visible ()

Opis

Funkcja zwraca informację o tym, czy artykuł skojarzony z bieżącym nagłówkiem jest widoczny w oknie, a mianowicie:

      0  : jeśli okno artykułów jest ukryte,
      1  : jeśli okno artykułów jest widoczne, ale bieżący nagłowek nie
             odnosi się do widocznego artykułu,
      3  : jeśli okno artykułów zawiera artykuł skojarzony z bieżącym
             nagłówkiem.

Uwagi

W pewnych przypadkach bardziej użyteczne może być użycie funkcji _is_article_visible. W rzeczywistości, funkcja is_article_visible mogłaby być napisana za pomocą _is_article_visible jako:

     define is_article_visible ()
     { 
         variable status = _is_article_visible ();
         !if (status & 1) return 0;
         return status;
     }

Zobacz również

_is_article_visible, is_article_window_zoomed, call

2.7 is_article_window_zoomed

Składnia

Integer is_article_window_zoomed ()

Opis

Funkcja ta zwraca 1, jeśli okno artykułów zajmuje cały ekran, i 0 w przeciwnym przypadku.

Zobacz również

is_article_visible, call

2.8 pipe_article

Składnia

Void pipe_article (String cmd)

Opis

Funkcja ta służy do przesłania potokiem treści bieżącego artykułu do polecenia określonego argumentem cmd. Jeśli okno artykułu jest ukryte, funkcja użyje artykułu skojarzonego z bieżącym nagłówkiem.

Zobacz również

read_mini

2.9 re_bsearch_article

Składnia

Integer re_bsearch_article (String_Type pat)

Opis

Funkcja działa tak jak re_search_article, ale szuka wstecz.

Zobacz również

re_search_article

2.10 re_search_article

Składnia

Integer re_search_article (String_Type pat)

Opis

Funkcja ta poszukuje napisu pasującego do wyrażenia regularnego podanego argumentem pat w treści bieżącego artykułu. Kierunek poszukiwań: do przodu. Zwracane jest 0, jeśli dopasowania nie znaleziono. W przeciwnym przypadku funkcja zwraca 1, a pasujący wiersz umieszczany jest na stosie.

Zobacz również

search_article

2.11 re_search_article_first

Składnia

Integer re_search_article_first (String_Type pat)

Opis

Działa tak samo jak re_search_article, ale zawsze szuka pierwszego dopasowania, licząc od początku artykułu.

Zobacz również

re_search_article

2.12 replace_article

Składnia

replace_article (String_Type string)

Opis

Funkcja zastępuje tekst obecnie wyświetlanego artykułu dowolnie wybranym napisem podanym jako argument.

Przykład

Następujący kod zamienia w całym artykule wielkie litery na małe:

     replace_article (strlow (article_as_string ()));

Zobacz również

article_as_string, is_article_visible

2.13 save_current_article

Składnia

Integer save_current_article (String filename)

Opis

Funkcja zapisuje treść bieżącego artykułu w pliku o nazwie podanej jako filename. Jeśli okno artykułu nie jest widoczne, ściąga artykuł skojarzony z bieżącym nagłówkiem. Funkcja zwraca 0 w razie sukcesu; w przeciwnym przypadku zwraca -1 i wyrzuca wyjątek błędu S-lang.

Uwagi

Funkcja zawsze tworzy nowy plik, nadpisując istniejący.

Zobacz również

2.14 search_article

Składnia

Integer search_article (String str)

Opis

Funkcja ta poszukuje napisu określonego argumentem pat w treści bieżącego artykułu (jeśli artykuł jest niewidoczny, to w treści artykułu skojarzonego z bieżącym nagłówkiem). Kierunek poszukiwań: do przodu. Jeśli tekstu nie znaleziono, zwraca 0. W przeciwnym przypadku funkcja zwraca 1, a wiersz zawierający znaleziony napis umieszczany jest na stosie.

Zobacz również

re_search_article

Zobacz również

search_article_first

2.15 search_article_first

Składnia

Integer search_article_first (String_Type pat)

Opis

Działa tak samo jak search_article, ale szuka pierwszego dopasowania, licząc od początku artykułu. Oznacza to, że można zanleźć wszystkie dopasowania w treści artykułu wywołując jeden raz search_article_first, a następnie używając search_article.

Zobacz również

search_article

2.16 set_article_window_size

Składnia

Void set_article_window_size (Integer nrows)

Opis

Funkcja ustawia wysokość okna artykułów. Można ten cel osiągnąć również za pomocą zmiennej SCREEN_HEIGHT.

Zobacz również

get_article_window_size

Funkcje slrn

1. Funkcje obsługujące nagłówki i wątkowanie

• 1.1 collapse_thread
• 1.2 collapse_threads
• 1.3 extract_article_header
• 1.4 extract_displayed_article_header
• 1.5 get_grouplens_score
• 1.6 get_header_flags
• 1.7 get_header_number
• 1.8 get_header_score
• 1.9 get_header_tag_number
• 1.10 get_visible_headers
• 1.11 goto_num_tagged_header
• 1.12 header_down
• 1.13 header_next_unread
• 1.14 header_up
• 1.15 headers_hidden_mode
• 1.16 is_thread_collapsed
• 1.17 locate_header_by_msgid
• 1.18 next_tagged_header
• 1.19 prev_tagged_header
• 1.20 re_bsearch_author
• 1.21 re_bsearch_subject
• 1.22 re_fsearch_author
• 1.23 re_fsearch_subject
• 1.24 set_header_display_format
• 1.25 set_header_flags
• 1.26 set_header_score
• 1.27 set_visible_headers
• 1.28 sort_by_sorting_method
• 1.29 thread_size
• 1.30 uncollapse_thread
• 1.31 uncollapse_threads

2. Funkcje dostępne w trybie artykułów

• 2.1 _is_article_visible
• 2.2 article_as_string
• 2.3 bsearch_article
• 2.4 get_article_window_size
• 2.5 get_next_art_pgdn_action
• 2.6 is_article_visible
• 2.7 is_article_window_zoomed
• 2.8 pipe_article
• 2.9 re_bsearch_article
• 2.10 re_search_article
• 2.11 re_search_article_first
• 2.12 replace_article
• 2.13 save_current_article
• 2.14 search_article
• 2.15 search_article_first
• 2.16 set_article_window_size

3. Funkcje dostępne w trybie grup

• 3.1 current_newsgroup
• 3.2 get_group_flags
• 3.3 get_group_order
• 3.4 group_down_n
• 3.5 group_search
• 3.6 group_unread
• 3.7 group_up_n
• 3.8 hide_current_group
• 3.9 is_group_mode
• 3.10 select_group
• 3.11 set_group_display_format
• 3.12 set_group_flags
• 3.13 set_group_order

4. Funkcje dialogowe i informacyjne

• 4.1 get_response
• 4.2 get_select_box_response
• 4.3 get_yes_no_cancel
• 4.4 message_now
• 4.5 popup_window
• 4.6 read_mini
• 4.7 read_mini_filename
• 4.8 read_mini_integer
• 4.9 read_mini_no_echo
• 4.10 read_mini_variable
• 4.11 select_list_box
• 4.12 set_input_chars
• 4.13 set_input_string

5. Interakcja z użytkownikiem

• 5.1 call
• 5.2 definekey
• 5.3 get_prefix_arg
• 5.4 getkey
• 5.5 input_pending
• 5.6 reset_prefix_arg
• 5.7 set_prefix_argument
• 5.8 undefinekey
• 5.9 ungetkey

6. Obsługa plików

• 6.1 close_log_file
• 6.2 log_message
• 6.3 make_home_filename
• 6.4 open_log_file
• 6.5 print_file

7. Inne funkcje

• 7.1 _slrn_version
• 7.2 _slrn_version_string
• 7.3 datestring_to_unixtime
• 7.4 get_bg_color
• 7.5 get_fg_color
• 7.6 get_variable_value
• 7.7 quit
• 7.8 register_hook
• 7.9 reload_scorefile
• 7.10 server_name
• 7.11 set_color
• 7.12 set_ignore_quotes
• 7.13 set_integer_variable
• 7.14 set_string_variable
• 7.15 set_strip_re_regexp
• 7.16 set_strip_sig_regexp
• 7.17 set_strip_was_regexp
• 7.18 set_utf8_conversion_table
• 7.19 setlocale
• 7.20 tt_send
• 7.21 unregister_hook
• 7.22 update

8. Funkcje obsługi zdarzeń (Hooks)

• 8.1 article_mode_hook
• 8.2 article_mode_quit_hook
• 8.3 article_mode_startup_hook
• 8.4 cc_hook
• 8.5 followup_hook
• 8.6 forward_hook
• 8.7 group_mode_hook
• 8.8 group_mode_startup_hook
• 8.9 header_number_hook
• 8.10 make_from_string_hook
• 8.11 post_file_hook
• 8.12 post_filter_hook
• 8.13 post_hook
• 8.14 pre_article_mode_hook
• 8.15 read_article_hook
• 8.16 reply_hook
• 8.17 resize_screen_hook
• 8.18 startup_hook
• 8.19 subject_compare_hook
• 8.20 supersede_hook