Hello, A few months ago a question was posed to the vim_use group about the use of the `formatprg` option [1]. Specifically, is it possible to pass the value of `textwidth` to the filter program?
Generally, one wants to use different filter parameters when working on different file types, so the simplest solution would be to set `formatprg` during the FileType event. Unfortunately, `formatprg` is a global-only option, so there cannot be different values for different file types and buffers. This patch converts `formatprg` into a global-local option, allowing for this functionality. Most other filterprg options (`equalprg`, `grepprg`, `keywordprg`, and `makeprg`) are already global-local, so there is precedent for this change. More details in the patch header, following inline and as an attachment. Cheers, Sung Pae [1]: http://groups.google.com/group/vim_use/browse_thread/thread/ffca45a9c8dd4da1 -- >From 3a37fa9fbe743d75b4bf7b76635ebd26e1cd0210 Mon Sep 17 00:00:00 2001 From: guns <s...@sungpae.com> Date: Sun, 7 Aug 2011 04:49:45 -0500 Subject: [PATCH] Convert formatprg to a global-local option. Since the purpose of the formatprg option is to allow external programs to reflow non-source text, it is useful to have different formatprgs set for different documents. For instance, you may want to use `par` globally: set formatprg=par\ 80 For mail messages, you would want to wrap to 72 characters and add quote handling options: autocmd FileType mail \ setlocal textwidth=72 formatprg=par\ q1\ 72 And if you were working on a complex plain-text document, with a left-hand gutter, justification, and non-standard tab expansions: autocmd BufRead,BufNewFile *.thesis \ setlocal tw=78 fp=par\ h3jT3\ 78 Note that while all of this could be done with a formatexpr, that option is intended for formatting source code and is generally more complicated to configure. --- runtime/doc/options.txt | 2 +- src/buffer.c | 1 + src/normal.c | 6 +++--- src/option.c | 19 ++++++++++++++++++- src/option.h | 1 + src/proto/option.pro | 1 + src/structs.h | 1 + 7 files changed, 26 insertions(+), 5 deletions(-) diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 3bfc05a..8bddb84 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -3210,7 +3210,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'formatprg'* *'fp'* 'formatprg' 'fp' string (default "") - global + global or local to buffer |global-local| {not in Vi} The name of an external program that will be used to format the lines selected with the |gq| operator. The program must take the input on diff --git a/src/buffer.c b/src/buffer.c index 24cbc06..ae9db49 100644 --- a/src/buffer.c +++ b/src/buffer.c @@ -1828,6 +1828,7 @@ free_buf_options(buf, free_p_ff) clear_string_option(&buf->b_p_efm); #endif clear_string_option(&buf->b_p_ep); + clear_string_option(&buf->b_p_fp); clear_string_option(&buf->b_p_path); clear_string_option(&buf->b_p_tags); #ifdef FEAT_INS_EXPAND diff --git a/src/normal.c b/src/normal.c index c028fea..1740a2f 100644 --- a/src/normal.c +++ b/src/normal.c @@ -2060,7 +2060,7 @@ do_pending_operator(cap, old_col, gui_yank) op_formatexpr(oap); /* use expression */ else #endif - if (*p_fp != NUL) + if (*get_formatprg() != NUL) op_colon(oap); /* use external command */ else op_format(oap, FALSE); /* use internal function */ @@ -2222,10 +2222,10 @@ op_colon(oap) } else if (oap->op_type == OP_FORMAT) { - if (*p_fp == NUL) + if (*get_formatprg() == NUL) stuffReadbuff((char_u *)"fmt"); else - stuffReadbuff(p_fp); + stuffReadbuff(get_formatprg()); stuffReadbuff((char_u *)"\n']"); } diff --git a/src/option.c b/src/option.c index 4db3027..a4c2ede 100644 --- a/src/option.c +++ b/src/option.c @@ -111,6 +111,7 @@ #define PV_FF OPT_BUF(BV_FF) #define PV_FLP OPT_BUF(BV_FLP) #define PV_FO OPT_BUF(BV_FO) +#define PV_FP OPT_BOTH(OPT_BUF(BV_FP)) #ifdef FEAT_AUTOCMD # define PV_FT OPT_BUF(BV_FT) #endif @@ -1208,7 +1209,7 @@ static struct vimoption {(char_u *)"^\\s*\\d\\+[\\]:.)}\\t ]\\s*", (char_u *)0L} SCRIPTID_INIT}, {"formatprg", "fp", P_STRING|P_EXPAND|P_VI_DEF|P_SECURE, - (char_u *)&p_fp, PV_NONE, + (char_u *)&p_fp, PV_FP, {(char_u *)"", (char_u *)0L} SCRIPTID_INIT}, {"fsync", "fs", P_BOOL|P_SECURE|P_VI_DEF, #ifdef HAVE_FSYNC @@ -5296,6 +5297,7 @@ check_buf_options(buf) check_string_option(&buf->b_p_efm); #endif check_string_option(&buf->b_p_ep); + check_string_option(&buf->b_p_fp); check_string_option(&buf->b_p_path); check_string_option(&buf->b_p_tags); #ifdef FEAT_INS_EXPAND @@ -9438,6 +9440,7 @@ get_varp_scope(p, opt_flags) case PV_MP: return (char_u *)&(curbuf->b_p_mp); #endif case PV_EP: return (char_u *)&(curbuf->b_p_ep); + case PV_FP: return (char_u *)&(curbuf->b_p_fp); case PV_KP: return (char_u *)&(curbuf->b_p_kp); case PV_PATH: return (char_u *)&(curbuf->b_p_path); case PV_AR: return (char_u *)&(curbuf->b_p_ar); @@ -9483,6 +9486,8 @@ get_varp(p) /* global option with local value: use local value if it's been set */ case PV_EP: return *curbuf->b_p_ep != NUL ? (char_u *)&curbuf->b_p_ep : p->var; + case PV_FP: return *curbuf->b_p_fp != NUL + ? (char_u *)&curbuf->b_p_fp : p->var; case PV_KP: return *curbuf->b_p_kp != NUL ? (char_u *)&curbuf->b_p_kp : p->var; case PV_PATH: return *curbuf->b_p_path != NUL @@ -9710,6 +9715,17 @@ get_equalprg() return curbuf->b_p_ep; } +/* + * Get the value of 'formatprg', buffer-local or global. + */ + char_u * +get_formatprg() +{ + if (*curbuf->b_p_fp == NUL) + return p_fp; + return curbuf->b_p_fp; +} + #if defined(FEAT_WINDOWS) || defined(PROTO) /* * Copy options from one window to another. @@ -10056,6 +10072,7 @@ buf_copy_options(buf, flags) buf->b_p_efm = empty_option; #endif buf->b_p_ep = empty_option; + buf->b_p_fp = empty_option; buf->b_p_kp = empty_option; buf->b_p_path = empty_option; buf->b_p_tags = empty_option; diff --git a/src/option.h b/src/option.h index 434f9f3..9f333aa 100644 --- a/src/option.h +++ b/src/option.h @@ -958,6 +958,7 @@ enum , BV_FF , BV_FLP , BV_FO + , BV_FP #ifdef FEAT_AUTOCMD , BV_FT #endif diff --git a/src/proto/option.pro b/src/proto/option.pro index 15cf2b4..91318ea 100644 --- a/src/proto/option.pro +++ b/src/proto/option.pro @@ -34,6 +34,7 @@ void free_one_termoption __ARGS((char_u *var)); void set_term_defaults __ARGS((void)); void comp_col __ARGS((void)); char_u *get_equalprg __ARGS((void)); +char_u *get_formatprg __ARGS((void)); void win_copy_options __ARGS((win_T *wp_from, win_T *wp_to)); void copy_winopt __ARGS((winopt_T *from, winopt_T *to)); void check_win_options __ARGS((win_T *win)); diff --git a/src/structs.h b/src/structs.h index 7b71a5f..50bedf4 100644 --- a/src/structs.h +++ b/src/structs.h @@ -1571,6 +1571,7 @@ struct file_buffer char_u *b_p_efm; /* 'errorformat' local value */ #endif char_u *b_p_ep; /* 'equalprg' local value */ + char_u *b_p_fp; /* 'formatprg' local value */ char_u *b_p_path; /* 'path' local value */ int b_p_ar; /* 'autoread' local value */ char_u *b_p_tags; /* 'tags' local value */ -- 1.7.6.295.gdcabd -- You received this message from the "vim_dev" maillist. Do not top-post! Type your reply below the text you are replying to. For more information, visit http://www.vim.org/maillist.php
0001-Convert-formatprg-to-a-global-local-option.patch
Description: Binary data
