Add Sorting Functionality for Quick Search Results

This commit adds sorting functionality to the Quick Search results,
allowing users to sort entries by Line Number, Text, and Path.

Fixes : #1940

Author: SougandhS

bundles/org.eclipse.text.quicksearch/src/org/eclipse/text/quicksearch/internal/ui/QuickSearchDialog.java

@@ -32,6 +32,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
+import java.util.Comparator;
 import java.util.Deque;
 import java.util.LinkedList;
 import java.util.List;
@@ -840,19 +841,47 @@ public void getName(AccessibleEvent e) {
 //		new ScrollListener(list.getTable().getVerticalBar());
 //		new SelectionChangedListener(list);
 
+		final int[] sortColumnIndex = {-1};
+		final boolean[] sortDirectionAscending = {true};
+		Table table = list.getTable();
 		TableViewerColumn col = new TableViewerColumn(list, SWT.RIGHT);
+		TableColumn column = col.getColumn();
+		column.setText(Messages.QuickSearchDialog_line);
+		column.setWidth(40);
+		column.addSelectionListener(new SelectionAdapter() {
+			@Override
+			public void widgetSelected(SelectionEvent e) {
+				Comparator<LineItem> lineNumberComparator = Comparator.comparingInt(LineItem::getLineNumber);
+				handleColumnSort( table, 0, lineNumberComparator, sortColumnIndex, sortDirectionAscending);
+			}
+		});
 		col.setLabelProvider(LINE_NUMBER_LABEL_PROVIDER);
-		col.getColumn().setText(Messages.QuickSearchDialog_line);
-		col.getColumn().setWidth(40);
+
 		col = new TableViewerColumn(list, SWT.LEFT);
-		col.getColumn().setText(Messages.QuickSearchDialog_text);
+		column = col.getColumn();
+		column.setText(Messages.QuickSearchDialog_text);
+		column.setWidth(400);
+		column.addSelectionListener(new SelectionAdapter() {
+			@Override
+			public void widgetSelected(SelectionEvent e) {
+				Comparator<LineItem> textComparator = Comparator.comparing( LineItem::getText);
+				handleColumnSort( table, 1, textComparator, sortColumnIndex, sortDirectionAscending);
+			}
+		});
 		col.setLabelProvider(LINE_TEXT_LABEL_PROVIDER);
-		col.getColumn().setWidth(400);
+
 		col = new TableViewerColumn(list, SWT.LEFT);
-		col.getColumn().setText(Messages.QuickSearchDialog_path);
+		column = col.getColumn();
+		column.setText(Messages.QuickSearchDialog_path);
+		column.setWidth(150);
+		column.addSelectionListener(new SelectionAdapter() {
+			@Override
+			public void widgetSelected(SelectionEvent e) {
+				Comparator<LineItem> lineItemComparator = Comparator.comparing( item -> item.getFile().getFullPath().toString());
+				handleColumnSort( table, 2,lineItemComparator, sortColumnIndex, sortDirectionAscending);
+			}
+		});
 		col.setLabelProvider(LINE_FILE_LABEL_PROVIDER);
-		col.getColumn().setWidth(150);
-
 		new TableResizeHelper(list).enableResizing();
 
 		//list.setLabelProvider(getItemsListLabelProvider());
@@ -951,6 +980,26 @@ public void keyPressed(KeyEvent e) {
 		return dialogArea;
 	}
 
+	private void handleColumnSort(Table table, int columnIndex, Comparator sorter,int[] sortColumnIndex, boolean[] sortDirectionAscending) {
+		if (sortColumnIndex[0] == columnIndex) {
+			sortDirectionAscending[0] = !sortDirectionAscending[0];
+		} else {
+			sortColumnIndex[0] = columnIndex;
+			sortDirectionAscending[0] = true;
+		}
+		table.setSortColumn(table.getColumn(columnIndex));
+		table.setSortDirection(sortDirectionAscending[0] ? SWT.UP : SWT.DOWN);
+
+		if(sortDirectionAscending[0]) {
+			contentProvider.setComparator(sorter);
+			contentProvider.sortList();
+		} else {
+			contentProvider.setComparator(sorter.reversed());
+			contentProvider.sortList();
+		}
+		refreshWidgets();
+	}
+
 	private Composite createNestedComposite(Composite parent, int numRows, boolean equalRows) {
 		Composite nested = new Composite(parent, SWT.NONE);
 		{
@@ -1227,6 +1276,7 @@ protected IDialogSettings getDialogSettings() {
 	public void refreshWidgets() {
 		if (list != null && !list.getTable().isDisposed()) {
 			int itemCount = contentProvider.getNumberOfElements();
+			contentProvider.sortList();
 			list.setItemCount(itemCount);
 			if (itemCount < MAX_RESULTS) {
 				listLabel.setText(NLS.bind(Messages.QuickSearchDialog_listLabel, itemCount));
@@ -1468,7 +1518,7 @@ private void applyPathMatcher() {
 	private class ContentProvider implements IStructuredContentProvider, ILazyContentProvider {
 
 		private List items;
-
+		private Comparator<LineItem> comparator;
 		/**
 		 * Creates new instance of <code>ContentProvider</code>.
 		 */
@@ -1511,6 +1561,9 @@ public void refresh() {
 		 */
 		@Override
 		public Object[] getElements(Object inputElement) {
+			if(comparator!=null) {
+				items.sort(comparator);
+			}
 			return items.toArray();
 		}
 
@@ -1551,6 +1604,25 @@ public void updateElement(int index) {
 
 		}
 
+		/**
+		 * Sorts the current search results based on current comparator
+		 */
+		public void sortList() {
+			if(comparator==null) {
+				return;
+			}
+			items.sort(comparator);
+		}
+
+		/**
+		 * Sets a custom comparator for comparing LineItem objects.
+		 *
+		 * @param comparator a <code>Comparator<code> object that defines the custom comparison logic.
+		 */
+		public void setComparator(Comparator<LineItem> comparator) {
+			this.comparator = comparator;
+		}
+
 	}
 
 	/**