/usr/share/gps/plug-ins/align.py is in gnat-gps-common 6.1.2016-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 | """Contextual menu for aligning text
This script provides a number of contextual menus to help align the
text in the selected region following a number of criteria. Some of these
criteria are Ada specific, but could easily be changed for other
languages. The contextual menus that do not apply will not be visible
when editing other languages
- Aligning on use clauses(Ada specific)
For example:
with Ada.Text_IO; use Ada.Text_IO;
with Foo; use Foo;
becomes
with Ada.Text_IO; use Ada.Text_IO;
with Foo; use Foo
- Alignining colons (Any language)
For example:
Foo_With_Long_Name : Integer;
Foo : Integer;
becomes
Foo_With_Long_Name : Integer;
Foo : Integer;
- Aligning on reserve word 'is' (Ada specific)
For example:
type Type_With_Long_Name is new Integer;
type Foo is new Natural;
becomes:
type Type_With_Long_Name is new Integer;
type Foo is new Natural;
- Aligning Ada formal parameters (Ada specific)
Aligns the colons, modes and format types in formal parameter specifications
For example,
procedure Q( This : in out Integer;
That_One : in Float := 0.0;
Yet_Another : access Integer;
Result : out Integer;
Default : Boolean );
becomes
procedure Q( This : in out Integer;
That_One : in Float := 0.0;
Yet_Another : access Integer;
Result : out Integer;
Default : Boolean );
- Aligning arrows (Ada specific)
aligns the => symbols (this implementation supports only 9 levels
of arrows).
For example,
Call (A => 2,
Long_Name => 3);
becomes
Call (A => 2,
Long_Name => 3);
- Aligning record representation clauses (Ada specific)
For example,
for T use
record
x at 0 range 0 .. 7;
yyyy at 12 range 0 .. 7;
xx at 0 range 0 .. 7;
k at 12345 range 0 .. 7;
end record;
becomes
for T use
record
x at 0 range 0 .. 7;
yyyy at 12 range 0 .. 7;
xx at 0 range 0 .. 7;
k at 12345 range 0 .. 7;
end record;
- Aligning assignments (Ada specific)
For example,
A := 2;
Long_Name := 3;
becomes
A := 2;
Long_Name := 3;
- Aligning end-of-line comments (Ada, C++ and Python)
For example,
A := 2; --Foo
B_Long := 3; -- bar
becomes
A := 2; -- Foo
B_Long := 3; -- bar
"""
############################################################################
# No user customization below this line
############################################################################
import re
import sys
import GPS
from gps_utils import *
def try_indent(buffer, top, bottom):
""" Ident text in given buffer between top and bottom position.
Ignore exceptions raised when ident setting is None"""
try:
buffer.indent(top, bottom)
except:
pass
def range_align_on(top, bottom, sep, replace_with=None, sep_group=0):
"""Align each line from top to bottom, aligning, for each line, sep in
the same column. For instance:
a sep b
long sep short
becomes:
a sep b
long sep short
sep is a regular expression.
top and bottom are instances of GPS.EditorLocation
replace_with is the text that should replace the text matched by sep.
It can do backward references to parenthesis groups in sep by using the
usual \1, \2,... strings. All the replacement texts will occupy the same
length in the editor, that is they will also be aligned.
"""
if bottom.beginning_of_line() == bottom:
bottom = bottom.forward_char(-1)
if not replace_with:
replace_with = sep
sep_re = re.compile(sep)
pos = 0
replace_len = 0
fin = False # whether formal in are found
fout = False # whether formal out are found
line = top.beginning_of_line()
while line <= bottom:
chars = top.buffer().get_chars(line, line.end_of_line())
matched = sep_re.search(chars)
if matched:
pos = max(pos, len(chars[:matched.start(sep_group)].rstrip()) + 1)
try:
sub = sep_re.sub(replace_with, matched.group(sep_group))
except:
sub = matched.group(sep_group)
if sub == " : out ":
fout = True
elif sub == " : in " or sub == " : in out ":
fin = True
replace_len = max(replace_len, len(sub))
prev = line
line = line.forward_line()
if prev == line:
break
# special case when in and out are used
if fin and fout:
replace_len = 10
if pos != 0:
line = top.beginning_of_line()
while line <= bottom:
chars = top.buffer().get_chars(line, line.end_of_line())
matched = sep_re.search(chars)
if matched:
width = pos - \
len(chars[:matched.start(sep_group)].rstrip()) - 1
try:
sub = sep_re.sub(replace_with, matched.group(sep_group))
except:
sub = matched.group(sep_group)
width2 = replace_len - len(sub)
# special case for out parameters, spaces before only if there
# is also some in parameters.
if sub == " : out " and fin:
sub = " : out "
width2 = width2 - 3
top.buffer().delete(line, line.end_of_line())
# do not left-strip if a single char as this will remove the \n
if len(chars[matched.end(sep_group):]) == 1:
top.buffer().insert(
line,
chars[:matched.start(sep_group)].rstrip()
+ (' ' * width) + sub + (' ' * width2)
+ chars[matched.end(sep_group):])
else:
top.buffer().insert(
line, chars[:matched.start(sep_group)].rstrip()
+ (' ' * width) + sub + (' ' * width2)
+ chars[matched.end(sep_group):].lstrip())
prev = line
line = line.forward_line()
if prev == line:
break
@with_save_excursion
def buffer_align_on(sep, replace_with=None, buffer=None, sep_group=0):
"""
Align the current selection in buffer, based on the separator sep.
See the description for range_align_on.
"""
if not buffer:
buffer = GPS.EditorBuffer.get()
top = buffer.selection_start()
bottom = buffer.selection_end()
if top == bottom:
GPS.MDI.dialog(
"You must first select the intended text (at least two lines)")
else:
tmark = top.create_mark()
bmark = bottom.create_mark(left_gravity=False)
try_indent(buffer, top, bottom)
range_align_on(
tmark.location(), bmark.location(), sep,
replace_with, sep_group=sep_group)
tmark.delete()
bmark.delete()
def get_commas(l):
n = 0
enabled = True
res = []
for k in range(0, len(l) - 1):
if l[k] == '"':
enabled = not enabled
elif enabled and l[k] == ',':
res.append(k)
n = n + 1
res.insert(0, n)
return res
def max_min(e1, e2):
res = [min(e1[0], e2[0])]
for k in range(1, res[0] + 1):
if k == 1:
m = max(e1[k], e2[k])
else:
m = max(e1[k] + m - e1[k - 1], e2[k] + m - e2[k - 1])
res.append(m)
return res
def in_rw_ada_file(context):
return (context.module_name == "Source_Editor"
and (in_ada_file(context) or
EditorBuffer.get().file().language().lower() in (
'project file',))
and is_writable(context))
@interactive("Ada", in_rw_ada_file, contextual="Align/Colons",
name="Align colons")
def align_colons():
"""
Aligns colons (eg in object and record type declarations) and trailing
text in current selection.
"""
buffer_align_on(sep=":(?!=)", replace_with=" : ")
@interactive("Ada", in_rw_ada_file, contextual="Align/Commas",
name="Align commas")
def align_commas():
"""
Aligns commas (eg actual parameters or arguments in pragmas) in
current selection.
"""
buffer = GPS.EditorBuffer.get()
top = buffer.selection_start()
bottom = buffer.selection_end()
tmark = top.create_mark("top")
bmark = bottom.create_mark("bottom")
if top == bottom:
GPS.MDI.dialog(
"You must first select the intended text (at least two lines)")
return False
if top.beginning_of_line() != top:
top = top.beginning_of_line()
if bottom.beginning_of_line() == bottom:
bottom = bottom.forward_char(-1)
try:
content = []
data = []
chars = ""
buffer.start_undo_group()
line = top.beginning_of_line()
while line <= bottom:
content.append(top.buffer().get_chars(line, line.end_of_line()))
line = line.forward_line()
for l in content:
data.append(get_commas(l))
mm = reduce(max_min, data)
for l in range(0, len(content)):
nl = ""
for c in range(0, mm[0] + 1):
if c == 0:
nl = nl + content[l][:data[l][c + 1] + 1]
nl = nl + ' ' * (mm[c + 1] - len(nl) + 1)
elif c == mm[0]:
nl = nl + content[l][data[l][c] + 1:]
else:
nl = nl + content[l][data[l][c] + 1:data[l][c + 1] + 1]
nl = nl + ' ' * (mm[c + 1] - len(nl) + 1)
chars = chars + nl
buffer.delete(top, bottom)
buffer.insert(top, chars)
tloc = buffer.get_mark("top").location()
bloc = buffer.get_mark("bottom").location()
buffer.select(tloc, bloc)
except:
GPS.Console().write(str(sys.exc_info()) + "\n")
finally:
top.buffer().finish_undo_group()
return True
@interactive("Ada", in_rw_ada_file, contextual="Align/Reserved word 'is'",
name="Align reserved is")
def align_reserved_is():
"""
Aligns reserved word 'is' (eg in type declarations) in
current selection.
"""
buffer_align_on(sep=" is ")
@interactive("Ada", in_rw_ada_file,
contextual="Align/Reserved word 'renames'",
name="Align reserved renames")
def align_renaming():
"""Aligns reserved word 'renames' in current selection"""
buffer_align_on(sep=" renames ")
@interactive("Ada", in_rw_ada_file, contextual="Align/Use clauses",
name="Align use clauses")
def align_use_clauses():
"""Aligns Ada use-clauses in current selection"""
buffer_align_on(sep=" use ")
@interactive("Ada", in_rw_ada_file, contextual="Align/Arrow symbols",
name="Align arrows")
@with_save_excursion
def align_arrows():
"""Aligns Ada arrow symbol '=>' in current selection"""
# The algorithm is the following:
# - indent the selection
# - for N 1 .. 9:
# - replace level Nth of => by a special tag @>
# - aling on the special tag @> replacing it with =>
buffer = GPS.EditorBuffer.get()
top = buffer.selection_start()
bottom = buffer.selection_end()
tmark = top.create_mark("top")
bmark = bottom.create_mark("bottom")
found = False
if top == bottom:
GPS.MDI.dialog("You must first select the intended text")
return
try:
buffer.start_undo_group()
for lr in range(9):
try_indent(buffer, top, bottom)
top = buffer.get_mark("top").location()
bottom = buffer.get_mark("bottom").location()
chars = buffer.get_chars(top, bottom)
level = 0
for k in range(len(chars)):
if chars[k] == '(':
level = level + 1
elif chars[k] == ')':
level = level - 1
elif chars[k] == '\n':
found = False
elif k + 4 < len(chars) and chars[k:k + 4] == "case":
level = level + 1
elif k + 8 < len(chars) and chars[k:k + 8] == "end case":
level = level - 1
elif (level == lr
and k + 2 < len(chars)
and chars[k:k + 2] == "=>"
and not found):
chars = chars[:k] + "@>" + chars[k + 2:]
found = True
buffer.delete(top, bottom)
buffer.insert(top, chars)
tmark = top.create_mark("top")
bmark = bottom.create_mark("bottom")
top = buffer.get_mark("top").location()
bottom = buffer.get_mark("bottom").location()
range_align_on(top, bottom, sep="@>", replace_with=" => ")
top = buffer.get_mark("top").location()
bottom = buffer.get_mark("bottom").location()
buffer.select(top, bottom)
except:
GPS.Console().write(str(sys.exc_info()) + "\n")
finally:
top.buffer().finish_undo_group()
@interactive("Ada", in_rw_ada_file, contextual="Align/Assignment symbols",
name="Align assignments")
def align_assignments():
"""Aligns Ada assignment symbol ':=' in current selection"""
buffer_align_on(sep=":=", replace_with=" := ")
@interactive("Ada", in_rw_ada_file, contextual="Align/Formal parameters",
name="Align formal parameters")
def align_formal_params():
"""
Aligns the colons, modes, and formal types in parameter specifications
"""
# The regexp needs the three nested groups, since we want \\1 to always
# returns at least the empty string
buffer_align_on(sep=":\s*(((in\s+out|out|in|access) )?)",
replace_with=" : \\1")
@interactive(category="Ada",
filter=in_rw_ada_file,
contextual="Align/Record representation clause",
name="Align record representation clause")
def align_record_rep_clause():
"""Aligns the various parts of a record representation clause"""
buffer_align_on(sep=" at ")
buffer_align_on(sep=" range ")
@interactive(category="Ada",
filter=in_rw_ada_file,
contextual="Align/End of line comments",
name="Align end of line comments")
def align_end_of_line_comments():
"""Align end of line comments"""
buffer = GPS.EditorBuffer.get()
if buffer.file().language() == "ada":
buffer_align_on(sep="\s*[^\s]+\s*( --\s*)",
replace_with=" -- ", sep_group=1)
else:
buffer_align_on(sep=" //\s*", replace_with=" // ")
buffer_align_on(sep=" #\s*", replace_with=" # ")
|