Function: icalendar-match-text-value

icalendar-match-text-value is a byte-compiled function defined in icalendar-parser.el.gz.

Signature

(icalendar-match-text-value S)

Documentation

Match string S against rx icalendar-text.

Source Code

;; Defined in /usr/src/emacs/lisp/calendar/icalendar-parser.el.gz
;; TODO: would it be useful to add a third representation, namely a
;; function or thunk?  So that e.g. Org can pre-process its own syntax
;; and return a plain text string to use in the description?
(ical:define-type ical:text "TEXT"
   "Type for Text values.

Text values can be represented in Elisp in two ways: as strings,
or as buffer regions.  For values which aren't expected to change,
such as property values in a text/calendar email attachment, use
strings.  For values which are user-editable and might change
between parsing and serializing to iCalendar format, use a
region.  In that case, a text value contains two markers BEGIN and
END which mark the bounds of the region.  See
`icalendar-make-text-region' to create such values, and
`icalendar-text-region-begin' and `icalendar-text-region-end' to
access the markers.

Certain characters in text values are required to be escaped by
the iCalendar standard.  These characters should NOT be
pre-escaped when inserting them into the parse tree.  Instead,
`icalendar-print-text' takes care of escaping text values, and
`icalendar-read-text' takes care of unescaping them, when parsing and
printing iCalendar data."
  '(or string (satisfies ical:text-region-p))
  (zero-or-more (or ical:text-safe-char ?: ?\" ical:escaped-char))
  :reader ical:read-text
  :printer ical:print-text
  :link "https://www.rfc-editor.org/rfc/rfc5545#section-3.3.11")