Blame - styleguide.xsl - platform/external/google-styleguide

<xsl:template match="a|address|blockquote|br|center|cite|code|dd|div|dl|dt|em|hr|i|img|li|ol|p|pre|span|table|td|th|tr|ul|var|A|ADDRESS|BLOCKQUOTE|BR|CENTER|CITE|CODE|DD|DIV|DL|DT|EM|HR|I|LI|OL|P|PRE|SPAN|TABLE|TD|TH|TR|UL|VAR">

mmentovai

6fb1d37

2008-06-27 20:10:09 +0000

[diff] [blame]

426

<xsl:element name="{local-name()}">

427

<xsl:copy-of select="@*"/>

428

<xsl:apply-templates/>

</xsl:element>

</xsl:template>

433

<xsl:template name="TOC">

434

<xsl:param name="root"/>

435

436

<DIV class="toc_title">Table of Contents</DIV>

437

<TABLE>

438

<xsl:for-each select="$root/CATEGORY">

439

440

<xsl:attribute name="class"><xsl:value-of select="@class"/></xsl:attribute>

<TD>

<A>

<xsl:attribute name="href">

445

<xsl:text>#</xsl:text>

446

<xsl:call-template name="anchorname">

447

<xsl:with-param name="sectionname" select="@title"/>

448

</xsl:call-template>

449

</xsl:attribute>

450

<xsl:value-of select="@title"/>

</A>

</DIV>

</TD><TD>

<xsl:for-each select="./STYLEPOINT">

456

457

<xsl:attribute name="class"><xsl:value-of select="@class"/></xsl:attribute>

458

<A>

459

<xsl:attribute name="href">

460

<xsl:text>#</xsl:text>

461

<xsl:call-template name="anchorname">

462

<xsl:with-param name="sectionname" select="@title"/>

463

</xsl:call-template>

464

</xsl:attribute>

465

<xsl:value-of select="@title"/>

466

</A>

467

</SPAN>

468

<xsl:text> </xsl:text>

</xsl:for-each>

</DIV>

</TD>

</TR>

</xsl:for-each>

</TABLE>

</DIV>

</xsl:template>

<xsl:template name="TOC_one_stylepoint">

479

<xsl:param name="stylepoint"/>

480

</xsl:template>

481

482

<!-- Creates a standard anchor given any text.

483

Substitutes underscore for characters unsuitable for URLs -->

484

<xsl:template name="anchorname">

485

<xsl:param name="sectionname"/>

mmentovai

db989ec

2010-11-23 18:02:36 +0000

[diff] [blame]

486

487

<xsl:variable name="bad_characters" select="" ()#'""/>

488

<xsl:value-of select="translate($sectionname,$bad_characters,'_____')"/>

mmentovai

6fb1d37

2008-06-27 20:10:09 +0000

[diff] [blame]

489

</xsl:template>

490

491

492

493

<xsl:template name="num_leading_spaces_one_line">

494

<xsl:param name="text"/>

495

<xsl:param name="current_count"/>

496

<xsl:choose>

497

<xsl:when test="starts-with($text, ' ')">

498

<xsl:call-template name="num_leading_spaces_one_line">

499

<xsl:with-param name="text" select="substring($text, 2)"/>

500

<xsl:with-param name="current_count" select="$current_count + 1"/>

</xsl:call-template>

</xsl:when>

<xsl:otherwise>

<xsl:value-of select="$current_count"/>

</xsl:otherwise>

</xsl:choose>

</xsl:template>

<!-- Given a block of text, each line terminated by \n, evaluates to

510

the indentation-level of that text; that is, the largest number

511

n such that every non-blank line starts with at least n spaces. -->

512

<xsl:template name="num_leading_spaces">

513

<xsl:param name="text"/>

514

<xsl:param name="max_so_far"/>

515

516

<xsl:variable name="line" select="substring-before($text, '
')"/>

517

<xsl:variable name="rest" select="substring-after($text, '
')"/>

518

<xsl:variable name="num_spaces_this_line">

519

<xsl:choose>

520

<xsl:when test="$line=''">

521

<xsl:value-of select="$max_so_far"/>

522

</xsl:when>

523

<xsl:otherwise>

524

<xsl:call-template name="num_leading_spaces_one_line">

525

<xsl:with-param name="text" select="$line"/>

526

<xsl:with-param name="current_count" select="0"/>

</xsl:call-template>

</xsl:otherwise>

</xsl:choose>

</xsl:variable>

<xsl:variable name="new_max_so_far">

532

<xsl:choose>

533

<xsl:when test="$num_spaces_this_line < $max_so_far">

534

<xsl:value-of select="$num_spaces_this_line"/>

535

</xsl:when>

536

<xsl:otherwise>

537

<xsl:value-of select="$max_so_far"/>

</xsl:otherwise>

</xsl:choose>

</xsl:variable>

542

<xsl:if test="$rest=''">

543

<xsl:value-of select="$new_max_so_far"/>

544

</xsl:if>

545

<xsl:if test="not($rest='')">

546

<xsl:call-template name="num_leading_spaces">

547

<xsl:with-param name="text" select="$rest"/>

548

<xsl:with-param name="max_so_far" select="$new_max_so_far"/>

</xsl:call-template>

</xsl:if>

</xsl:template>

mmentovai

2009-03-25 22:24:14 +0000

[diff] [blame]

553

<!-- Given text, determine the starting position of code.

554

This similar to num_leading_spaces_one_line but treats "Yes:" and "No:"

555

as spaces. Also, if there is no code on the first line, it searches

556

subsequent lines until a non-empty line is found.

557

Used to find the start of code in snippets like:

Yes: if(foo):

No : if(foo):

As well as:

Yes:

if (foo):

-->

<xsl:template name="code_start_index">

565

<xsl:param name="text"/>

566

<xsl:param name="current_count"/>

567

<xsl:choose>

568

<xsl:when test="starts-with($text, ' ')">

569

<xsl:call-template name="code_start_index">

570

<xsl:with-param name="text" select="substring($text, 2)"/>

571

<xsl:with-param name="current_count" select="$current_count + 1"/>

572

</xsl:call-template>

573

</xsl:when>

574

<xsl:when test="starts-with($text, 'Yes:')">

575

<xsl:call-template name="code_start_index">

576

<xsl:with-param name="text" select="substring($text, 5)"/>

577

<xsl:with-param name="current_count" select="$current_count + 4"/>

578

</xsl:call-template>

579

</xsl:when>

580

<xsl:when test="starts-with($text, 'No:')">

581

<xsl:call-template name="code_start_index">

582

<xsl:with-param name="text" select="substring($text, 4)"/>

583

<xsl:with-param name="current_count" select="$current_count + 3"/>

584

</xsl:call-template>

585

</xsl:when>

586

<!-- This is only reached if the first line is entirely whitespace or

587

contains nothing but "Yes:" or "No:"-->

588

<xsl:when test="starts-with($text, '
')">

589

<xsl:call-template name="code_start_index">

590

<xsl:with-param name="text" select="substring($text, 2)"/>

591

<xsl:with-param name="current_count" select="0"/>

</xsl:call-template>

</xsl:when>

<xsl:otherwise>

<xsl:value-of select="$current_count"/>

</xsl:otherwise>

</xsl:choose>

</xsl:template>

<!-- Helper for ends_with_colon. Determine whether the given line is nothing

601

but spaces and python-style comments. -->

602

<xsl:template name="is_blank_or_comment">

603

<xsl:param name="line"/>

604

<xsl:choose>

605

<xsl:when test="$line = ''">

606

<xsl:value-of select="1"/>

607

</xsl:when>

608

<xsl:when test="starts-with($line, '
')">

609

<xsl:value-of select="1"/>

610

</xsl:when>

611

<xsl:when test="starts-with($line, '#')">

612

<xsl:value-of select="1"/>

613

</xsl:when>

614

<xsl:when test="starts-with($line, ' ')">

615

<xsl:call-template name="is_blank_or_comment">

616

<xsl:with-param name="line" select="substring($line, 2)"/>

</xsl:call-template>

</xsl:when>

<xsl:otherwise>

<xsl:value-of select="0"/>

</xsl:otherwise>

</xsl:choose>

</xsl:template>

<!-- Determine whether the given line ends with a colon. Note that Python

626

style comments are ignored so the following lines return True:

- def foo():

- def foo(): # Bar

- if(foo):

But some code may confuse this function. For example the following are

632

also consider to "end_with_colon" even though they don't for Python

633

- foo(": #")

634

- foo() # No need for :

635

-->

636

<xsl:template name="ends_with_colon">

637

<xsl:param name="line"/>

638

<xsl:param name="found_colon"/>

639

<xsl:choose>

640

<xsl:when test="$line = ''">

641

<xsl:value-of select="$found_colon"/>

642

</xsl:when>

643

<xsl:when test="starts-with($line, '
')">

644

<xsl:value-of select="$found_colon"/>

645

</xsl:when>

646

<xsl:when test="starts-with($line, ' ')">

647

<xsl:call-template name="ends_with_colon">

648

<xsl:with-param name="line" select="substring($line, 2)"/>

649

<xsl:with-param name="found_colon" select="$found_colon"/>

650

</xsl:call-template>

651

</xsl:when>

652

<xsl:when test="starts-with($line, ':')">

653

<xsl:variable name="rest_is_comment">

654

<xsl:call-template name="is_blank_or_comment">

655

<xsl:with-param name="line" select="substring($line, 2)"/>

</xsl:call-template>

</xsl:variable>

<xsl:choose>

<xsl:when test="$rest_is_comment = '1'">

660

<xsl:value-of select="1"/>

661

</xsl:when>

662

<xsl:otherwise>

663

<xsl:call-template name="ends_with_colon">

664

<xsl:with-param name="line" select="substring($line, 2)"/>

665

<xsl:with-param name="found_colon" select="0"/>

</xsl:call-template>

</xsl:otherwise>

</xsl:choose>

</xsl:when>

<xsl:otherwise>

<xsl:call-template name="ends_with_colon">

672

<xsl:with-param name="line" select="substring($line, 2)"/>

673

<xsl:with-param name="found_colon" select="0"/>

</xsl:call-template>

</xsl:otherwise>

</xsl:choose>

</xsl:template>

<!-- Prints one line of python code with proper indent and calls itself

680

recursively for the rest of the text.

681

This template uses "a", "b", "c" and "d" to refer to four key column

682

numbers. They are:

683

- a: the indentation common to all lines in a code snippet. This is

684

stripped out to allow for cleaner code in the xml.

685

- b: the indentation of the most out-dented line of code. This is

686

different from "a" when code is labelled with "Yes:" or "No:"

687

- c: the indentation of the current python block, in other words, the

688

indentation of the first line of this block, which is the

689

indentation of the last line we saw that ended with a colon.

690

- d: the "total" indentation of the line, ignorng possible "Yes:" or

691

"No:" text on the line.

692

693

For example, for the last line of the following code snippet, the

694

positions of a, b, c and d are indicated below:

Yes: def Foo():

if bar():

a += 1

baz()

a b c d

The algorithm is:

1) Split the text into first line and the rest. Note that the

703

substring-before function is supposed to handle the case where the

704

character is not present in the string but does not so we

705

automatically ignore the last line of the snippet which is always

706

empty (the closing snippet tag). This is consistent with the

707

behavior or print_without_leading_chars.

708

2) If the current is empty (only whitespace), print newline and call

709

itself recursively on the rest of the text with the rest of the

710

parameters unchanged.

711

3) Otherwise, measure "d"

712

4) Measure "c" by taking:

713

- the value of "d" if the previous line ended with a colon or the

714

current line is outdented compare to the previous line

715

- the indent of the previous line otherwise

716

5) Print line[a:c] (Note that we ignore line[0:a])

717

6) Print line[b:c] in an external span (in order to double the block

718

indent in external code).

719

7) Print line[c:<end>] with function names processed to produce both

720

internal and external names.

721

8) If there are more lines, recurse.

722

-->

723

<xsl:template name="print_python_line_recursively">

724

<xsl:param name="text"/>

725

<xsl:param name="a"/>

726

<xsl:param name="b"/>

727

<xsl:param name="previous_indent"/>

728

<xsl:param name="previous_ends_with_colon"/>

729

<xsl:param name="is_first_line"/>

730

<xsl:variable name="line" select="substring-before($text, '
')"/>

731

<xsl:variable name="rest" select="substring-after($text, '
')"/>

732

<xsl:choose>

733

<xsl:when test="substring($line, $b) = '' and not($rest = '')">

734

<xsl:if test="not($is_first_line = '1')">

735

<xsl:text>
</xsl:text>

736

</xsl:if>

737

<xsl:call-template name="print_python_line_recursively">

738

<xsl:with-param name="text" select="$rest"/>

739

<xsl:with-param name="a" select="$a"/>

740

<xsl:with-param name="b" select="$b"/>

741

<xsl:with-param name="previous_indent" select="$previous_indent"/>

742

<xsl:with-param name="previous_ends_with_colon"

743

select="$previous_ends_with_colon"/>

744

<xsl:with-param name="is_first_line" select="0"/>

</xsl:call-template>

</xsl:when>

<xsl:otherwise>

<xsl:variable name="indent_after_b">

749

<xsl:call-template name="num_leading_spaces_one_line">

750

<xsl:with-param name="text" select="substring($line, $b + 1)"/>

751

<xsl:with-param name="current_count" select="0"/>

752

</xsl:call-template>

753

</xsl:variable>

754

<xsl:variable name="d" select="$b + $indent_after_b"/>

755

<xsl:variable name="c">

756

<xsl:choose>

757

<xsl:when test="$previous_ends_with_colon = '1' or

758

$previous_indent > $d">

759

<xsl:value-of select="$d"/>

760

</xsl:when>

761

<xsl:otherwise>

762

<xsl:value-of select="$previous_indent"/>

</xsl:otherwise>

</xsl:choose>

</xsl:variable>

<xsl:value-of select="substring($line, $a + 1, $c - $a)"/>

768

769

<xsl:value-of select="substring($line, $b + 1, $c - $b)"/>

770

</span>

771

<xsl:call-template name="munge_function_names_in_text">

772

<xsl:with-param name="stripped_line"

773

select="substring($line, $c + 1)"/>

774

</xsl:call-template>

775

<xsl:if test="not(substring($rest, $a) = '')">

776

<xsl:text>
</xsl:text>

777

<xsl:call-template name="print_python_line_recursively">

778

<xsl:with-param name="text" select="$rest"/>

779

<xsl:with-param name="a" select="$a"/>

780

<xsl:with-param name="b" select="$b"/>

781

<xsl:with-param name="previous_indent" select="$c"/>

782

<xsl:with-param name="previous_ends_with_colon">

783

<xsl:call-template name="ends_with_colon">

784

<xsl:with-param name="line" select="$line"/>

785

<xsl:with-param name="found_colon" select="0"/>

786

</xsl:call-template>

787

</xsl:with-param>

788

<xsl:with-param name="is_first_line" select="0"/>

</xsl:call-template>

</xsl:if>

</xsl:otherwise>

</xsl:choose>

</xsl:template>

<!-- Print python code with internal and external styles.

796

In order to conform with PEP-8 externally, we identify 2-space indents

797

and an external-only 4-space indent.

798

Function names that are marked with $$FunctionName/$$ have an external

799

lower_with_underscore version added. -->

800

<xsl:template name="print_python_code">

801

<xsl:param name="text"/>

802

803

<xsl:variable name="a">

804

<xsl:call-template name="num_leading_spaces">

805

<xsl:with-param name="text" select="."/>

806

<xsl:with-param name="max_so_far" select="1000"/>

</xsl:call-template>

</xsl:variable>

<xsl:variable name="b">

811

<xsl:call-template name="code_start_index">

812

<xsl:with-param name="text" select="$text"/>

813

<xsl:with-param name="current_count" select="0"/>

</xsl:call-template>

</xsl:variable>

<xsl:call-template name="print_python_line_recursively">

818

<xsl:with-param name="text" select="$text"/>

819

<xsl:with-param name="a" select="$a"/>

820

<xsl:with-param name="b" select="$b"/>

821

<xsl:with-param name="previous_indent" select="$b"/>

822

<xsl:with-param name="previous_ends_with_colon" select="0"/>

823

<xsl:with-param name="is_first_line" select="1"/>

</xsl:call-template>

</xsl:template>

mmentovai

2008-06-27 20:10:09 +0000

[diff] [blame]

827

<!-- Given a block of text, each line terminated by \n, and a number n,

828

emits the text with the first n characters of each line

829

deleted. If strip==1, then we omit blank lines at the beginning

830

and end of the text (but not the middle!) -->

831

832

<xsl:template name="print_without_leading_chars">

833

<xsl:param name="text"/>

834

<xsl:param name="trim_count"/>

835

<xsl:param name="strip"/>

836

<xsl:param name="is_firstline"/>

837

838

<xsl:variable name="line" select="substring-before($text, '
')"/>

839

<xsl:variable name="rest" select="substring-after($text, '
')"/>

mmentovai

71619d3

2009-03-25 22:24:14 +0000

[diff] [blame]

840

<xsl:variable name="stripped_line" select="substring($line, $trim_count+1)"/>

mmentovai

6fb1d37

2008-06-27 20:10:09 +0000

[diff] [blame]

841

<xsl:choose>

842

843

<xsl:when test="($strip = '1') and ($is_firstline = '1') and

844

(string-length($line) <= $trim_count)">

845

</xsl:when>

846

<xsl:when test="($strip = '1') and

847

(string-length($rest) <= $trim_count)">

mmentovai

71619d3

2009-03-25 22:24:14 +0000

[diff] [blame]

848

<xsl:value-of select="$stripped_line"/>

mmentovai

6fb1d37

2008-06-27 20:10:09 +0000

[diff] [blame]

849

</xsl:when>

850

<xsl:otherwise>

mmentovai

71619d3

2009-03-25 22:24:14 +0000

[diff] [blame]

851

<xsl:value-of select="$stripped_line"/>

mmentovai

6fb1d37

2008-06-27 20:10:09 +0000

[diff] [blame]

852

<xsl:text>
</xsl:text>

853

</xsl:otherwise>

854

</xsl:choose>

855

<xsl:if test="not($rest='')">

856

<xsl:call-template name="print_without_leading_chars">

857

<xsl:with-param name="text" select="$rest"/>

858

<xsl:with-param name="trim_count" select="$trim_count"/>

859

<xsl:with-param name="strip" select="$strip"/>

860

<xsl:with-param name="is_firstline" select="0"/>

</xsl:call-template>

</xsl:if>

</xsl:template>

mmentovai

2009-03-25 22:24:14 +0000

[diff] [blame]

865

<!-- Given a line of code, find function names that are marked with $$ /$$ and

866

print out the line with the internal and external versions of the

867

function names.-->

868

<xsl:template name="munge_function_names_in_text">

869

<xsl:param name="stripped_line"/>

870

<xsl:choose>

871

<xsl:when test="contains($stripped_line, '$$')">

872

<xsl:value-of select="substring-before($stripped_line, '$$')"/>

873

<xsl:call-template name="print_function_name">

874

<xsl:with-param name="text" select="substring-after(substring-before($stripped_line, '/$$'), '$$')"/>

875

</xsl:call-template>

876

<xsl:call-template name="munge_function_names_in_text">

877

<xsl:with-param name="stripped_line" select="substring-after($stripped_line, '/$$')"/>

</xsl:call-template>

</xsl:when>

<xsl:otherwise>

<xsl:value-of select="$stripped_line"/>

</xsl:otherwise>

</xsl:choose>

</xsl:template>

<!-- Given a function name, print out both the internal and external version

887

of the function name in their respective spans.-->

888

<xsl:template name="print_function_name">

889

<xsl:param name="text"/>

mmentovai

71619d3

2009-03-25 22:24:14 +0000

[diff] [blame]

890

<xsl:call-template name="convert_camel_case_to_lowercase_with_under">

891

<xsl:with-param name="text" select="$text"/>

892

</xsl:call-template>

mmentovai

71619d3

2009-03-25 22:24:14 +0000

[diff] [blame]

893

</xsl:template>

894

895

<!-- Given a single word of text convert it from CamelCase to

896

lower_with_under.

897

This means replacing each uppercase character with _ followed by the

898

lowercase version except for the first character which is replaced

899

without adding the _.-->

900

<xsl:template name="convert_camel_case_to_lowercase_with_under">

901

<xsl:param name="text"/>

902

<xsl:param name="is_recursive_call"/>

903

<xsl:variable name="first_char" select="substring($text, 1, 1)"/>

904

<xsl:variable name="rest" select="substring($text, 2)"/>

905

<xsl:choose>

906

<xsl:when test="contains('ABCDEFGHIJKLMNOPQRSTUVWXYZ', $first_char)">

907

<xsl:if test="$is_recursive_call='1'">

908

<xsl:text>_</xsl:text>

909

</xsl:if>

910

<xsl:value-of select="translate($first_char, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz')"/>

911

</xsl:when>

912

<xsl:otherwise>

913

<xsl:value-of select="$first_char" />

914

</xsl:otherwise>

915

</xsl:choose>

916

<xsl:if test="not($rest='')">

917

<xsl:call-template name="convert_camel_case_to_lowercase_with_under">

918

<xsl:with-param name="text" select="$rest"/>

919

<xsl:with-param name="is_recursive_call" select="1"/>

920

</xsl:call-template>

921

</xsl:if>

922

</xsl:template>

mmentovai

6fb1d37

2008-06-27 20:10:09 +0000

[diff] [blame]

923

</xsl:stylesheet>

924